Deep C++(V20.09)

autor:ichiroprogrammer

イントロダクション

このドキュメントは、C++の深い理解を促進するためのものである。 SOLIDデザインパターン を解説するドキュメントは珍しいものではないが、 一時、C++がその進化を止め、瀕死の状態に陥ったため、 両概念についてをC++で解説したドキュメントはきわめて珍しいと思われる。 また、C++の言語的な特徴であり、その優秀さを際立たせる テンプレートメタプログラミングダイナミックメモリアロケーションについて、 十分な知識を提供するドキュメントは上記と同様にきわめて珍しいと思われる。

改訂履歴

このドキュメントの構成


SOLID

SOLIDとは、オブジェクト指向(OOD/OOP)プログラミングにおいて特に重要な下記の5つの原則である。

このドキュメントの構成に戻る。


単一責任の原則(SRP)

単一責任の原則(SRP, Single Responsibility Principle)とは、

というクラスデザイン上の制約である。

下記クラスSentenceHolderNotSRPは、一見問題ないように見えるが、std::stringの保持と、 その出力という二つの責務を持つため、SRP違反である。

    //  example/solid/srp_ut.cpp 27

    class SentenceHolderNotSRP {
    public:
        SentenceHolderNotSRP()  = default;
        ~SentenceHolderNotSRP() = default;

        void Add(std::string const& sentence) { sentence_ += sentence; }

        std::string const& Get() const noexcept { return sentence_; }

        void Save(std::string const& file)
        {
            std::ofstream o{file};
            o << sentence_;
        }

        void Display() { std::cout << sentence_; }

    private:
        std::string sentence_{};
    };

実践的にはこの程度の単純なクラスでのSRP違反が問題になることは少ないが、 下記のコメントで示す通り、単体テストの実施が困難になる。

    //  example/solid/srp_ut.cpp 53

    auto not_srp = SentenceHolderNotSRP{};

    not_srp.Add("haha\n");
    not_srp.Add("hihi\n");
    not_srp.Add("huhu\n");

    // SRPに従っていないため、テストが面倒
    not_srp.Save(not_srp_text_);  // not_srp_text_への書き込み

    auto ifs       = std::ifstream{not_srp_text_};
    auto ifs_begin = std::istreambuf_iterator<char>{ifs};
    auto ifs_end   = std::istreambuf_iterator<char>{};
    auto act       = std::string{ifs_begin, ifs_end};  // not_srp_text_ファイルの読み出し

    ASSERT_EQ("haha\nhihi\nhuhu\n", act);

    // SRPに従っていないため、テストできない
    not_srp.Display();

クラスSentenceHolderNotSRPの二つの責務をクラスSentenceHolderSRPと、 Output()に分離したコード実装例を下記する。

    //  example/solid/srp_ut.cpp 75

    class SentenceHolderSRP {
    public:
        SentenceHolderSRP()  = default;
        ~SentenceHolderSRP() = default;

        void Add(std::string const& sentence) { sentence_ += sentence; }

        std::string const& Get() const noexcept { return sentence_; }

    private:
        std::string sentence_{};
    };

    // SRPに従うために、
    //    SentenceHolderNotSRP::Save(), SentenceHolderNotSRP::Display()
    // をクラスの外に出し、さらに仮引数に出力先(std::ostream&)を追加してこの2関数を統一。
    void Output(SentenceHolderSRP const& sentence_holder, std::ostream& o) { o << sentence_holder.Get(); }

下記のコードで示したように、この分離の効果で単体テストの実施が容易になった。

    //  example/solid/srp_ut.cpp 98

    auto srp = SentenceHolderSRP{};

    srp.Add("haha\n");
    srp.Add("hihi\n");
    srp.Add("huhu\n");

    // SRPに従ったことで、ファイル操作やstd::coutへの操作が不要になり、単体テストの実施が容易
    auto act = std::ostringstream{};
    Output(srp, act);

    ASSERT_EQ("haha\nhihi\nhuhu\n", act.str());

オープン・クローズドの原則(OCP)

オープン・クローズドの原則(OCP, Open-Closed Principle)とは、

というクラスデザイン上の制約である。

まずは、アンチパターンから示す。

    //  example/solid/ocp_ut.cpp 14

    class TransactorGoogle {
    public:
        static bool Pay(Yen price) noexcept
        {
            // ...
        }

        static bool Charge(Yen price) noexcept
        {
            // ...
        }
    };

    class TransactorSuica {
        // ...
    };

    class TransactorEdy {
    public:
        // ...
    };

    class TransactorNotOCP {
    public:
        enum class TransactionMethod { Google, Suica, Edy };

        explicit TransactorNotOCP(TransactionMethod pay_method) noexcept : pay_method_{pay_method} {}

        // ...
        bool Charge(Yen price) noexcept
        {
            switch (pay_method_) {
            case TransactionMethod::Google:
                return TransactorGoogle::Charge(price);
            case TransactionMethod::Suica:
                return TransactorSuica::Charge(price);
                // ...
            }
        }

        bool Pay(Yen price) noexcept
        {
            switch (pay_method_) {
            case TransactionMethod::Google:
                return TransactorGoogle::Pay(price);
            case TransactionMethod::Suica:
                return TransactorSuica::Pay(price);
                // ...
            }
        }
        // ...
    };

Transaction Method(enum TransactionMethod)が増えた場合、 少なくとも3か所に手を入れなけばならなくなる(修正に対してclosedでない)。 従って、下記のTransactorNotOCP::Charge()や、TransactorNotOCP::Pay()は Transaction Methodの追加、変更に対して、脆弱な構造だと言える。

次に上記ソースコードのクラス図を下記する。

クラス図が示す通り、 TransactorNotOCPは、TransactorGoogle, TransactorSuica, TransactorEdy (Transaction Methodに対応した具体的なクラス)に強く依存する。 したがって、新たなTransactor Methodが追加されれば、 Transaction Methodを使用しているTransactorNotOCPのすべてのメンバ関数は影響を受ける。 この構造は、上位概念が下位概念に依存しているとも言えるため、 後述する「依存関係逆転の原則(DIP)」にも反している。

下記は、TransactorIFを導入することによって、上例をOCPに沿うように改善したクラス図と実装である。 TransactorOCPは、TransactorIFの効果によりTransaction Methodの追加に対して全く影響を受けなくなった (実際には、TransactorIFから派生する具象クラスの生成用Factory関数(「Factory」参照) が必要になるため全く影響がないわけではないが、 そのような箇所はソースコード全体でただ一つにすることができるため、 Transaction Methodの追加に対して強固な構造になったと言える)。

下記にこのクラス図に従ったコードを示す。

    //  example/solid/ocp_ut.cpp 122

    class TransactorIF {
    public:
        // ...
        bool Charge(Yen price) noexcept { return charge(price); }
        bool Pay(Yen price) noexcept { return pay(price); }

    private:
        virtual bool charge(Yen price) = 0;
        virtual bool pay(Yen price)    = 0;
    };

    class TransactorGoogle : public TransactorIF {
        // ...
    };

    class TransactorSuica : public TransactorIF {
        // ...
    };

    class TransactorEdy : public TransactorIF {
        // ...
    };

    class TransactorOCP {
    public:
        explicit TransactorOCP(std::unique_ptr<TransactorIF>&& transactor) noexcept : transactor_{std::move(transactor)} {}

        bool Charge(Yen price) noexcept { return transactor_->Charge(price); }

        bool Pay(Yen price) noexcept { return transactor_->Pay(price); }

    private:
        std::unique_ptr<TransactorIF> transactor_;
    };

ここでは、この原則に沿う実装方法としてポリモーフィズムを使うパターンを紹介したが、 Pimplのようにラッピングを使用するパターンも有用である。

リスコフの置換原則(LSP)

リスコフの置換原則(LSP, Liskov Substitution Principle)とは、

というクラスデザイン上の制約であり、 この制約を守るために下記のような契約プログラミングを行うことが求められる。

この原則に従わない実装例を示すために、以下のようなクラスRectangleとその派生クラスSquareを定義する。

    //  example/solid/lsp.h 5

    /// @brief (0, 0) からの矩形を表す
    class Rectangle {
    public:
        explicit Rectangle(int x, int y) noexcept : x_{x}, y_{y} {}
        // ...
        void SetX(int x) noexcept
        {
            auto temp = y_;
            set_x(x);
            assert(temp == y_);  // 「set_xはy_に影響を与えない」が事後条件
        }
        // ...

    protected:
        virtual void set_x(int x) noexcept { x_ = x; }

        // ...

    private:
        int x_;
        int y_;
    };

    /// @brief (0, 0) からの正方形を表す
    class Square : public Rectangle {
    public:
        explicit Square(int x) noexcept : Rectangle{x, x} {}
        // ...
    protected:
        virtual void set_x(int x) noexcept override
        {
            Rectangle::set_x(x);
            Rectangle::set_y(x);
        }

        virtual void set_y(int y) noexcept override { set_x(y); }
    };

Rectangleのリファレンスを受け取るSetX()とその単体テストを以下のようにすると、 Rectangleのテストでは問題は起こらないが、同じことをSquareに行うとアボートしてしまう (下記例ではASSERT_DEATHを使用しアボートすることを確認している)。

    //  example/solid/lsp_ut.cpp 13

    void SetX(Rectangle& rect, int x) noexcept { rect.SetX(x); }

    TEST(LSP_Opt, violation_abort)
    {
        // Rectangleのテスト
        auto rect = Rectangle{0, 0};
        SetX(rect, 3);
        ASSERT_EQ(3, rect.GetX());

        // Squareのテスト
        auto square = Square{0};
        ASSERT_DEATH(SetX(square, 3), "");  // ここでRectangle::SetX()の中のassert()がfailする。
    }

上記コードがアボート(assertion fail)してしまったのは

が原因である。このデザイン上の問題には目をつぶり(Rectangle、Squareを修正せずに)、 しかもアボートしないSetX()の実装を考えてみよう。

SetX()は仮引数で渡されたオブジェクトの実際の型がわからなければアボートを避けることはできない。 従って、 新しいSetX()のコード実装例は以下のようになる。

    //  example/solid/lsp_ut.cpp 32

    void SetX(Rectangle& rect, int x) noexcept
    {
        if (dynamic_cast<Square*>(&rect) != nullptr) {
            rect = Square(x);
        }
        else {
            // rectの型は、Rectangle
            rect.SetX(x);
        }
    }

    TEST(LSP, violation_not_abort)
    {
        // Rectangleのテスト
        auto rect = Rectangle{0, 0};
        SetX(rect, 3);
        ASSERT_EQ(3, rect.GetX());

        // Squareのテスト
        auto square = Square{0};
        SetX(square, 3);  // assert()はfailしない。
        ASSERT_EQ(3, square.GetX());
    }

上記の新たなSetX()は、アボートはしないがきわめて醜悪且つ、 Rectangleの全派生クラスに依存した、変更に弱い関数となる。

なお、リスコフの置換原則とは関係しないが、上記のdynamic_castを含むSetX()は、 下記のように修正することができる。

    //  example/solid/lsp_ut.cpp 61

    void SetX(Rectangle& rect, int x) noexcept
    {
        auto y = rect.GetY();
        rect   = Rectangle(x, y);
    }

このSetX()は、Rectangleからの派生クラスに依存していないため、良い解法に見える。 ところが実際にはオブジェクトのスライシングという別の問題を引き起こす。

例示した問題は結局のところデザインの誤りが原因であり、それを修正しない限り、 問題の回避は容易ではない。

一般に、継承関係は、IS-Aの関係と呼ばれる。数学の世界では「正方形 is a 長方形」であるため、 この関係を継承で表したのだが、 「Rectangle::SetX()の性質より導き出されたRectangle::set_x()の事後条件」 により、「クラスSquare is NOT a クラスRectangle」となり、 SquareとRectangleは継承関係ではないため問題が発生した。

継承を用いなければこのような問題は発生しないため、public継承を使用する際には、 「本当にその関係は継承で表すべきか(それが最もシンプルな方法か)?」 について熟慮する必要がある。

なお、エクセプション記述子は、関数のエクセプション仕様を強制的にLSPに従わせる仕組みであるが、 C++11から非推奨になり、C++17では規格から削除された。 その理由は、 「非推奨だった古い例外仕様を削除」 の説明の通り、これを使用し場合、OCPに違反する可能性が高いからである。 従って、原則に従うのみでなく、その他の原則とのバランスも考慮する必要がある。

インターフェース分離の原則(ISP)

インターフェース分離の原則 (ISP, Interface Segregation Principle)とは、

というクラスデザイン上の制約である。

まずは、ISPに従っていない例を示す。 下記のStreamReadWriterは、ClientRからはStreamReadWriter::Read()のみが、 ClientWからはStreamReadWriter::Write()のみが使用されている。

ほとんどのStreamReadWriter使用ファイルでこのような依存関係がある場合、 このクラスは下記のようにStreamReaderとStreamWriterに分割した方が良い(依存関係が小さくなる)。

クラスの設計時に統合か分割かで悩むことは多いが、一度統合してしまえば分割は困難であり、 逆に分割されたものを統合することは容易である。このことを考慮すれば、 このような逡巡に解を与えることは簡単である。言うまでもないが、「まずは分割」が原則である。

依存関係逆転の原則(DIP)

依存関係逆転の原則 (DIP, Dependency Inversion Principle)とは、

というクラス デザイン上の制約である。

下記ServerNG::Serverは、ClientNG::Clientに非同期サービスを提供する (従って、ServerNG::ServerはClientNG::Clientに対して上位概念である)。

非同期サービスであるServerNG::Server::RequireStringAsync()の完了は ServerNG::ServerがClientNG::Client::Done()を呼び出すことにより通知される。
その実装、使用例を下記に示す。

    //  example/solid/dip_server_ng.h 10

    namespace ServerNG {
    class Server {
    public:
        Server();
        void RequireStringAsync(ClientNG ::Client& client) noexcept;
        // ...
    };
    }  // namespace ServerNG
    //  example/solid/dip_server_ng.cpp 6

    namespace ServerNG {
    namespace {
    void dispatch(ClientNG::Client& client)  // コマンドのディスパッチ
    {
        switch (client.GetNum()) {
        case 1:
            client.Done(new std::string{"hello"});
            break;
        case 2:
            client.Done(new std::string{"good bye"});
            break;
            // ...
        }
    }

    void thread_entry(Pipe& pipe)  // サーバーのスレッド関数
    {
        for (;;) {
            ClientNG::Client* client{nullptr};
            auto const        ret = pipe.Read(&client, sizeof(client));
            assert(ret == sizeof(client));

            if (client == nullptr) {  // nullptr受信でサーバー終了
                break;
            }

            dispatch(*client);
        }
    }
    }  // namespace
    // ...

    void Server::RequireStringAsync(ClientNG::Client& client) noexcept
    {
        void const* const buff{&client};

        auto ret = pipe_.Write(&buff, sizeof(buff));
        assert(ret == sizeof(&client));
    }
    // ...
    }  // namespace ServerNG
    //  example/solid/dip_client_ng.h 10

    namespace ClientNG {
    class Client {
    public:
        explicit Client(ServerNG::Server& server) noexcept : server_{server}, pipe_{}, num_{0} {}

        std::string GetString(uint32_t num);

        void Done(std::string* str) noexcept  // サーバーからクライアントへのコマンド終了通知
        {
            auto const ret = pipe_.Write(&str, sizeof(str));
            assert(ret == sizeof(str));
        }

        // ...
    };
    }  // namespace ClientNG
    //  example/solid/dip_client_ng.cpp 3

    namespace ClientNG {
    std::string Client::GetString(uint32_t num)
    {
        set_num(num);
        server_.RequireStringAsync(*this);

        return *wait_done();  // 非同期通知待ち
    }

    std::unique_ptr<std::string> Client::wait_done()
    {
        std::string* str{nullptr};
        auto const   ret = pipe_.Read(&str, sizeof(str));
        assert(ret == sizeof(str));

        return std::unique_ptr<std::string>{str};
    }
    }  // namespace ClientNG
    //  example/solid/dip_ut.cpp 11

    TEST(DIP, ng_pattern)
    {
        auto server = ServerNG::Server{};
        auto client = ClientNG::Client{server};

        auto actual = client.GetString(1);
        ASSERT_EQ("hello", actual);

        actual = client.GetString(2);
        ASSERT_EQ("good bye", actual);

        actual = client.GetString(3);
        ASSERT_EQ("unknown", actual);
    }

上記ソースコードから明らかなようにServerNG::ServerとClientNG::Clientは相互に依存している。 このうちの一つはサーバがクライアントに依存(上位概念が下位概念に依存)する問題のある構造となっている。

このため、クライアントのバリエーションが増えた場合、容易にServerNG::Serverのコードは肥大化する。 また、ServerNG::Serverを介して各クライアント間にも(暗黙、明示両方の)依存関係が生まれやすいため、 ServerNG::Serverのコード修正は非常に困難になることが予想される。

次にDIPに従い上記コードを改善した例を示す。

    //  example/solid/dip_server_ok.h 7

    namespace ServerOK {
    class ClientIF {
    public:
        ClientIF() noexcept : num_{0} {}
        void Done(std::string* str) { done(str); }  // サーバーからクライアントへのコマンド終了通知
        // ...
    private:
        virtual void done(std::string* str) = 0;
        // ...
    };

    class Server {
    public:
        Server();
        void RequireStringAsync(ClientIF& client) noexcept;
        // ...
    };
    }  // namespace ServerOK
    //  example/solid/dip_server_ok.cpp 5

    namespace ServerOK {
    namespace {
    void dispatch(ClientIF& client)  // コマンドのディスパッチ
    {
        switch (client.GetNum()) {
        case 1:
            client.Done(new std::string{"hello"});
            break;
        case 2:
            client.Done(new std::string{"good bye"});
            break;
            // ...
        }
    }

    void thread_entry(Pipe& pipe)  // サーバーのスレッド関数
    {
        for (;;) {
            ClientIF*  client{nullptr};
            auto const ret = pipe.Read(&client, sizeof(client));
            assert(ret == sizeof(client));

            if (client == nullptr) {  // nullptr受信でサーバー終了
                break;
            }

            dispatch(*client);
        }
    }
    }  // namespace
    // ...

    void Server::RequireStringAsync(ClientIF& client) noexcept
    {
        void const* const buff{&client};

        auto ret = pipe_.Write(&buff, sizeof(buff));
        assert(ret == sizeof(&client));
    }
    // ...
    }  // namespace ServerOK
    //  example/solid/dip_client_ok.h 10

    namespace ClientOK {
    class Client : public ServerOK::ClientIF {
    public:
        explicit Client(ServerOK::Server& server) noexcept : ClientIF{}, server_{server}, pipe_{} {}

        std::string GetString(uint32_t num);

        // ...
    };
    }  // namespace ClientOK
    //  example/solid/dip_client_ok.cpp 3

    namespace ClientOK {
    std::string Client::GetString(uint32_t num)
    {
        SetNum(num);
        server_.RequireStringAsync(*this);

        return *wait_done();  // 非同期通知待ち
    }

    std::unique_ptr<std::string> Client::wait_done()
    {
        std::string* str{nullptr};
        auto const   ret = pipe_.Read(&str, sizeof(str));
        assert(ret == sizeof(str));

        return std::unique_ptr<std::string>{str};
    }
    }  // namespace ClientOK
    //  example/solid/dip_ut.cpp 28

    // 使用方法は、ServerNG, ClientNGと同じ。
    TEST(DIP, ok_pattern)
    {
        auto server = ServerOK::Server{};
        auto client = ClientOK::Client{server};

        // 以下、ng_paternと同じ
        // ...
    }

修正後のコードは、

このクラス図を以下に示す。

ServerNGとClientNGの双方向依存関係は、ClientOKからServerOKへの単方向依存関係へと改善され、 サーバに影響を与えることなく、クライアントの機能変更やバリエーション追加を行うことが可能となった。

まとめ

以上で述べたように、SOLIDはオブジェクト指向(OOD/OOP)プログラミングにおいて極めて重要な原則である。 この逸脱はソースコードを劣化させ、ソフトウェアの品質低下や開発費増大に直結するため、 厳守することが求められる。

デザインパターン

ソースコードを劣化させるアンチパターンには、

等があるだろう。 こういった問題は、ひどいソースコードを書かないという強い意志を持ったプログラマの不断の努力と、 そのプログラマを支えるソフトウェア工学に基づいた知識によって回避可能である。 本章ではその知識の一翼をになうデザインパターン、イデオム等を解説、例示する。

なお、ここに挙げるデザインパターン、イデオム等は「適切な場所に適用される場合、 ソースコードをよりシンプルに記述できる」というメリットがある一方で、 「不適切な場所に適用される場合、ソースコードの複雑度を不要に上げてしまう」 という負の一面を持つ。

また、デザインパターン、イデオム等を覚えたてのプログラマは、 自分のスキルが上がったという一種の高揚感や顕示欲を持つため、 それをむやみやたらに多用してしまう状態に陥ることある。このようなプログラマの状態を

と呼ぶ。 猿になり不要に複雑なソースコードを書かないために、デザインパターン、イデオム等を使用する場合、 本当にそれが必要か吟味し、不要な場所への適用を避けなければならない。


この章の構成

   ガード節
   BitmaskType
   Pimpl
   lightweight Pimpl
   Accessor
   Copy-And-Swap
   Immutable
   Clone(仮想コンストラクタ)
   NVI(non virtual interface)
   RAII(scoped guard)
   Future
   DI(dependency injection)
   Singleton
   State
   Null Object
   Templateメソッド
   Factory
   Named Constructor
   Proxy
   Strategy
   Visitor
   CRTP(curiously recurring template pattern)
   Observer
   MVC
   Cでのクラス表現

このドキュメントの構成に戻る。
___

ガード節

ガード節とは、 「可能な場合、処理を早期に打ち切るために関数やループの先頭に配置される短い条件文(通常はif文)」 であり、以下のような利点がある。

まずは、ガード節を使っていない例を上げる。

    //  example/design_pattern/guard_ut.cpp 24

    /// @brief a(配列へのリファレンス)の要素について、先頭から'a'が続く数を返す
    /// @param 配列へのリファレンス
    int32_t SequentialA(char const (&a)[3]) noexcept
    {
        if (a[0] == 'a') {
            if (a[1] == 'a') {
                if (a[2] == 'a') {
                    return 3;
                }
                else {
                    return 2;
                }
            }
            else {
                return 1;
            }
        }
        else {
            return 0;
        }
    }

上記の例を読んで一目で何が行われているか、理解できる人は稀である。 一方で、上記と同じロジックである下記関数を一目で理解できない人も稀である。

    //  example/design_pattern/guard_ut.cpp 77

    int32_t SequentialA(char const (&a)[3]) noexcept
    {
        if (a[0] != 'a') {  // ガード節
            return 0;
        }
        if (a[1] != 'a') {  // ガード節
            return 1;
        }
        if (a[2] != 'a') {  // ガード節
            return 2;
        }

        return 3;
    }

ここまで効果的な例はあまりない。

もう一例、(ガード節導入の効果が前例ほど明確でない)ガード節を使っていないコードを示す。

    //  example/design_pattern/guard_ut.cpp 48

    std::optional<std::vector<uint32_t>> PrimeNumbers(uint32_t max_num)
    {
        auto result = std::vector<uint32_t>{};

        if (max_num < 65536) {  // 演算コストが高いためエラーにする
            if (max_num >= 2) {
                auto is_num_prime = std::vector<bool>(max_num + 1, true);  // falseなら素数でない
                is_num_prime[0] = is_num_prime[1] = false;
                auto prime_num                    = 2U;  // 最初の素数

                do {
                    result.emplace_back(prime_num);
                    prime_num = next_prime_num(prime_num, is_num_prime);
                } while (prime_num < is_num_prime.size());
            }

            return result;
        }

        return std::nullopt;
    }

上記にガード節を適用した例を下記する。

    //  example/design_pattern/guard_ut.cpp 94

    std::optional<std::vector<uint32_t>> PrimeNumbers(uint32_t max_num)
    {
        if (max_num >= 65536) {  // ガード節。演算コストが高いためエラーにする。
            return std::nullopt;
        }

        auto result = std::vector<uint32_t>{};

        if (max_num < 2) {  // ガード節。2未満の素数はない。
            return result;
        }

        auto is_num_prime = std::vector<bool>(max_num + 1, true);  // falseなら素数でない。
        is_num_prime[0] = is_num_prime[1] = false;
        auto prime_num                    = 2U;  // 最初の素数

        do {
            result.emplace_back(prime_num);
            prime_num = next_prime_num(prime_num, is_num_prime);
        } while (prime_num < is_num_prime.size());

        return result;
    }

ガード節を使っていない例に比べて、

といった改善はされたものの、最初の例ほどのレベル差はない。 しかし、ソースコードの改善やリファクタリングのほとんどは、このようなものであり、 この少しのレベルアップが数か月後、数年後に大きな差を生み出すことを忘れてはならない。

BitmaskType

下記のようなビットマスク表現は誤用しやすいインターフェースである。 修正や拡張等に関しても脆弱であるため、避けるべきである。

    //  example/design_pattern/enum_operator.h 6

    class Animal {
    public:
        struct PhisicalAbility {  // オブジェクトの状態を表すためのビットマスク
            static constexpr auto Run  = 0b0001U;
            static constexpr auto Fly  = 0b0010U;
            static constexpr auto Swim = 0b0100U;
        };

        // paにはPhisicalAbilityのみを受け入れたいが、実際にはすべてのuint32_tを受け入れる。
        explicit Animal(uint32_t pa) noexcept : phisical_ability_{pa} {}

        uint32_t GetPhisicalAbility() const noexcept { return phisical_ability_; }
        // ...
    };
    //  example/design_pattern/enum_operator_ut.cpp 13

    Animal dolphin{Animal::PhisicalAbility::Swim};  // OK
    ASSERT_EQ(Animal::PhisicalAbility::Swim, dolphin.GetPhisicalAbility());

    Animal uma{0xff};  // NG 誤用だが、コンストラクタの仮引数の型がuint32_tなのでコンパイル可能

上記のような誤用を防ぐために、 enumによるビットマスク表現を使用して型チェックを強化した例を以下に示す。 このテクニックは、STLのインターフェースとしても使用されている強力なイデオムである。

    //  example/design_pattern/enum_operator.h 30

    class Animal {
    public:
        enum class PhisicalAbility : uint32_t {
            Run  = 0b0001,
            Fly  = 0b0010,
            Swim = 0b0100,
        };

        explicit Animal(PhisicalAbility pa) noexcept : phisical_ability_{pa} {}

        PhisicalAbility GetPhisicalAbility() const noexcept { return phisical_ability_; }

    private:
        PhisicalAbility const phisical_ability_;
    };

    // &, | &=, |=, IsTrue, IsFalseの定義
    constexpr Animal::PhisicalAbility operator&(Animal::PhisicalAbility x, Animal::PhisicalAbility y) noexcept
    {
        return static_cast<Animal::PhisicalAbility>(static_cast<uint32_t>(x) & static_cast<uint32_t>(y));
    }

    constexpr Animal::PhisicalAbility operator|(Animal::PhisicalAbility x, Animal::PhisicalAbility y) noexcept
    {
        return static_cast<Animal::PhisicalAbility>(static_cast<uint32_t>(x) | static_cast<uint32_t>(y));
    }

    inline Animal::PhisicalAbility& operator&=(Animal::PhisicalAbility& x, Animal::PhisicalAbility y) noexcept
    {
        return x = x & y;
    }

    // ...
    //  example/design_pattern/enum_operator_ut.cpp 28

    // コンストラクタの仮引数の型が厳密になったためコンパイル不可
    // これにより誤用を防ぐ
    // Animal uma{0xff};

    // C++17から下記はコンパイル可能となったが、アクシデントでこのようなミスはしないだろう
    auto uma = Animal{Animal::PhisicalAbility{0xff}};

    auto dolphin = Animal{Animal::PhisicalAbility::Swim};
    ASSERT_EQ(Animal::PhisicalAbility::Swim, dolphin.GetPhisicalAbility());

    auto pa = Animal::PhisicalAbility{Animal::PhisicalAbility::Run};
    pa |= Animal::PhisicalAbility::Swim;

    auto human = Animal{pa};
    ASSERT_TRUE(IsTrue(Animal::PhisicalAbility::Run & human.GetPhisicalAbility()));

この改善により、Animalのコンストラクタに域値外の値を渡すことは困難になった (少なくとも不注意で間違うことはないだろう)。 この修正の延長で、Animal::GetPhisicalAbility()の戻り値もenumになり、これも誤用が難しくなった。

Pimpl

このパターンは、「クラスA(a.cpp、a.hで宣言、定義)を使用するクラスにAの実装の詳細を伝搬させたくない」 ような場合に使用する。 そのためオープン・クローズドの原則(OCP)の実装方法としても有用である。

一般的に、STLライブラリのパースは多くのCPUタイムを消費する。 クラスAがSTLクラスをメンバに使用し、a.hにそのSTLヘッダファイルがインクルードされた場合、 a.hをインクルードするファイルをコンパイルする度にそのSTLヘッダファイルはパースされる。 これはさらに多くのCPUタイムの消費につながり、ソースコード全体のビルドは遅くなる。 こういった問題をあらかじめ避けるためにも有効な手段ではあるが、 そのトレードオフとして実行速度は若干遅くなる。

下記は、Pimplイデオム未使用の、std::stringに依存したクラスStringHolderOldの例である。

    //  example/design_pattern/string_holder_old.h 3
    // このファイルには<string>が必要

    #include <memory>
    #include <string>

    class StringHolderOld final {
    public:
        StringHolderOld();

        void        Add(char const* str);
        char const* GetStr() const;

    private:
        std::unique_ptr<std::string> str_;
    };
    //  example/design_pattern/string_holder_old.cpp 1

    #include "string_holder_old.h"

    StringHolderOld::StringHolderOld() : str_{std::make_unique<std::string>()} {}

    void StringHolderOld::Add(char const* str) { *str_ += str; }

    char const* StringHolderOld::GetStr() const { return str_->c_str(); }

下記は、上記クラスStringHolderOldにPimplイデオムを適用したクラスStringHolderNewの例である。

    //  example/design_pattern/string_holder_new.h 3
    // このファイルには<string>は不要

    #include <memory>

    class StringHolderNew final {
    public:
        StringHolderNew();

        void        Add(char const* str);
        char const* GetStr() const;
        ~StringHolderNew();  // デストラクタは.cppで=defaultで定義

    private:
        class StringHolderNewCore;  // StringHolderNewの振る舞いは、StringHolderNewCoreに移譲
        std::unique_ptr<StringHolderNewCore> core_;
    };
    //  example/design_pattern/string_holder_new.cpp 1
    // このファイルには<string>が必要

    #include <string>

    #include "string_holder_new.h"

    class StringHolderNew::StringHolderNewCore final {
    public:
        StringHolderNewCore() = default;
        void Add(char const* str) { str_ += str; }

        char const* GetStr() const noexcept { return str_.c_str(); }

    private:
        std::string str_{};
    };

    StringHolderNew::StringHolderNew() : core_{std::make_unique<StringHolderNewCore>()} {}

    void StringHolderNew::Add(char const* str) { core_->Add(str); }

    char const* StringHolderNew::GetStr() const { return core_->GetStr(); }

    // この宣言、定義をしないと、StringHolderNewをインスタンス化した場所では、
    // StringHolderNewCoreが不完全型であるため、std::unique_ptrが実体化できず、コンパイルエラーとなる。
    // この場所であれば、StringHolderNewCoreは完全型であるためstd::unique_ptrが実体化できる。
    StringHolderNew::~StringHolderNew() = default;

下記図は、上記ファイルやそれらを使用するファイルの依存関係である。 string_holder_old.hは、std::stringに依存しているが、string_holder_new.hは、 std::stringに依存していないこと、 それによってStringHolderNewを使用するファイルから、std::stringへの依存を排除できていることがわかる。

このパターンを使用して問題のある依存関係をリファクタリングする例を示す。

まずは、リファクタリング前のコードを下記する。

    // in lib/h/widget.h

    #include "gtest/gtest.h"

    class Widget {
    public:
        void     DoSomething();
        uint32_t GetValue() const;
        // 何らかの宣言

    private:
        uint32_t gen_xxx_data(uint32_t a);
        uint32_t xxx_data_{1};
        FRIEND_TEST(Pimpl, widget_ng);  // 単体テストをfriendにする
    };
    // in lib/src/widget.cpp

    #include "widget.h"

    void Widget::DoSomething()
    {
        // 何らかの処理
        xxx_data_ = gen_xxx_data(xxx_data_);
    }

    uint32_t Widget::GetValue() const { return xxx_data_; }

    uint32_t WidgetNG::Widget::gen_xxx_data(uint32_t a) { return a * 3; }
    // in lib/ut/widget_ut.cpp

    #include "widget.h"

    TEST(Pimpl, widget_ng)
    {
        Widget w;

        ASSERT_EQ(1, w.xxx_data_);  // privateのテスト
        w.DoSomething();
        ASSERT_EQ(3, w.xxx_data_);        // privateのテスト
        ASSERT_EQ(9, w.gen_xxx_data(3));  // privateのテスト

        ASSERT_EQ(3, w.GetValue());
    }

何らかの事情により、単体テストでprivateなメンバにアクセスする必要があったため、 単体テストクラスをテスト対象クラスのfriendすることで、それを実現している。

単体テストクラスをテスト対象クラスのfriendにするためには、 上記コードの抜粋である下記を記述する必要がある。

        FRIEND_TEST(Pimpl, widget_ng);  // 単体テストをfriendにする

このマクロは、gtest.h内で定義されているため、widget.hからgtest.hをインクルードしている。

このため、ファイルの依存関係は下記のようになる。

この依存関係は、Widgetのクライアントに不要な依存関係を強要してしまう問題のある構造を作り出す。

この問題をPimplによるリファクタリングで解決したコードを以下に示す (コンパイラのインクルードパスにはlib/hのみが入っていることを前提とする)。

    // in lib/h/widget.h

    #include <memory>

    class Widget {
    public:
        Widget();   // widget_pimplは不完全型であるため、コンストラクタ、
        ~Widget();  // デストラクタはインラインにできない
        void     DoSomething();
        uint32_t GetValue() const;
        // 何らかの宣言

        struct widget_pimpl;  // 単体テストのため、publicとするが、実装はsrc/の下に置くため、
                              // 単体テスト以外の外部からのアクセスはできない

    private:
        std::unique_ptr<widget_pimpl> widget_pimpl_;
    };
    // in lib/src/widget.cpp

    #include "widget_internal.h"

    // widget_pimpl
    void Widget::widget_pimpl::DoSomething()
    {
        // 何らかの処理
        xxx_data_ = gen_xxx_data(xxx_data_);
    }

    uint32_t Widget::widget_pimpl::gen_xxx_data(uint32_t a) { return a * 3; }

    // Widget
    void     Widget::DoSomething() { widget_pimpl_->DoSomething(); }
    uint32_t Widget::GetValue() const { return widget_pimpl_->xxx_data_; }

    // ヘッダファイルの中では、widget_pimplは不完全型であるため、コンストラクタ、
    // デストラクタは下記に定義する
    Widget::Widget() : widget_pimpl_{std::make_unique<Widget::widget_pimpl>()} {}
    Widget::~Widget() = default;
    // in lib/src/widget_internal.h

    #include "widget.h"

    struct Widget::widget_pimpl {
        void     DoSomething();
        uint32_t gen_xxx_data(uint32_t a);
        uint32_t xxx_data_{1};
    };
    // in lib/ut/widget_ut.cpp

    #include "../src/widget_internal.h"  // 単体テストのみに、このようなインクルードを認める
    #include "gtest/gtest.h"

    TEST(Pimpl, widget_ok)
    {
        Widget::widget_pimpl wi;

        ASSERT_EQ(1, wi.xxx_data_);
        wi.DoSomething();
        ASSERT_EQ(3, wi.xxx_data_);
        ASSERT_EQ(9, wi.gen_xxx_data(3));

        Widget w;

        w.DoSomething();
        ASSERT_EQ(3, w.GetValue());
    }

このリファクタリングにより、ファイルの依存は下記のようになり、 問題のある構造は解消された。

lightweight Pimpl

Pimplの解説で示したように依存関係をシンプルに保つには極めて有効なパターンではあるが、 このパターンで実装されたクラスのインスタンス化のたびに一回以上のヒープからのアロケーションが必要になるため、 このオーバーヘッドが気になるような場合に備えて、アロケーションを少なくするテクニックを以下に示す (なお、lightweight Pimplとは筆者の造語であり、ここで紹介するパターンはPimplの一種である)。

    //  example/design_pattern/light_pimpl.h 8

    class LightPimpl {
    public:
        LightPimpl(std::string const& name);
        ~LightPimpl();
        LightPimpl(LightPimpl const&)            = delete;  // コピーは禁止
        LightPimpl& operator=(LightPimpl const&) = delete;  // コピーは禁止

        std::vector<uint8_t> const& GetVector() const;
        std::string const&          GetName() const;

        static constexpr size_t BufferLen = 10;
        uint8_t (&GetBuffer())[BufferLen];
        uint8_t const (&GetBuffer() const)[BufferLen];  // const を追加

    private:
        // Impl_tをプレースメントnewでインスタンス化する時に使用するメモリ
        alignas(std::max_align_t) uint8_t memory_[48];  // 配列長はsizeof(Impl_t)以上になるよう調整
        struct Impl_t;
        struct Impl_t* pimpl_;
    };

このクラスの実装を以下に示す。

    //  example/design_pattern/light_pimpl_ut.cpp 5

    namespace {
    bool constructor_called = false;  // テスト用フラグであるため、実装には無関係
    bool destructor_called  = false;  // テスト用フラグであるため、実装には無関係
    }  // namespace

    struct LightPimpl::Impl_t {
        Impl_t(std::string const& name) : name_{name} { constructor_called = true; /* コンストラクタが呼ばれたマーク */ }
        std::vector<uint8_t> vect_{};
        std::string          name_{};
        uint8_t              buffer_[BufferLen]{};

        ~Impl_t() { destructor_called = true; /* デストラクタが呼ばれたマーク */ }
    };

    LightPimpl::LightPimpl(std::string const& name) : pimpl_(new (memory_) Impl_t{name})  // プレースメントnew
    {
        static_assert(sizeof(Impl_t) <= sizeof(memory_), "Buffer size mismatch");
        static_assert(sizeof(memory_) - sizeof(Impl_t) < 16, "Buffer has excessive padding");
        static_assert(alignof(Impl_t) <= alignof(std::max_align_t), "Buffer alignment mismatch");
    }

    LightPimpl::~LightPimpl() { pimpl_->~Impl_t(); }  // Impl_tのデストラクタを直接呼び出す

    std::vector<uint8_t> const& LightPimpl::GetVector() const { return pimpl_->vect_; }
    std::string const&          LightPimpl::GetName() const { return pimpl_->name_; }

    uint8_t (&LightPimpl::GetBuffer())[LightPimpl::BufferLen] { return pimpl_->buffer_; }

    uint8_t const (&LightPimpl::GetBuffer() const)[LightPimpl::BufferLen] { return pimpl_->buffer_; }

ヒープ以外のメモリからnewするためのプレースメントnewを使用しているため、 上記の抜粋である以下のコードはやや見慣れないかもしれない。

    //  example/design_pattern/light_pimpl_ut.cpp 21

    LightPimpl::LightPimpl(std::string const& name) : pimpl_(new (memory_) Impl_t{name})  // プレースメントnew
    {
        static_assert(sizeof(Impl_t) <= sizeof(memory_), "Buffer size mismatch");
        static_assert(sizeof(memory_) - sizeof(Impl_t) < 16, "Buffer has excessive padding");
        static_assert(alignof(Impl_t) <= alignof(std::max_align_t), "Buffer alignment mismatch");
    }

プレースメントnewで構築したオブジェクトの解放にはdeleteは使えない。 オブジェクトがその上で構築されているメモリはヒープのものではないため、deleteすると未定義動作につながる。

deleteを使わずにプレースメントnewで構築したオブジェクトの各メンバのデストラクタを呼び出さなければ、 リソースリークにつながる。この問題を解決するためのコードは、上記の抜粋である以下のようなものになる。

    //  example/design_pattern/light_pimpl_ut.cpp 30

    LightPimpl::~LightPimpl() { pimpl_->~Impl_t(); }  // Impl_tのデストラクタを直接呼び出す

上記のクラスの動作を以下の単体テストにより示す。

    //  example/design_pattern/light_pimpl_ut.cpp 48

    {
        ASSERT_FALSE(constructor_called);
        LightPimpl lp{"lp"};

        ASSERT_EQ(lp.GetName(), "lp");
        ASSERT_EQ(lp.GetVector().size(), 0);
        ASSERT_EQ(lp.GetBuffer()[0], 0x0);

        ASSERT_TRUE(constructor_called);
        ASSERT_FALSE(destructor_called);
    };  // この行で、lpは解放される

    ASSERT_TRUE(destructor_called);

[ 通常のPimplとの比較 ]

特徴 通常のPimpl Lightweight Pimpl
メモリ確保 ヒープ スタック(オブジェクト内)
アロケーション回数 インスタンス毎に1回以上 0回
パフォーマンス new/deleteのオーバーヘッド 通常のPimplより良い
実装の複雑さ シンプル やや複雑(プレースメントnew)
メモリサイズの柔軟性 高い 低い(コンパイル時に固定)

Accessor

publicメンバ変数とそれにアクセスするソースコードは典型的なアンチパターンであるため、 このようなコードを禁じるのが一般的なプラクティスである。

    //  example/design_pattern/accessor_ut.cpp 8

    class A {  // アンチパターン
    public:
        int32_t a_{0};
    };

    void f(A& a) noexcept
    {
        a.a_ = 3;

        // Do something
        // ...
    }

とはいえ、ソフトウェアのプラクティスには必ずといってほど例外があり、 製品開発の現場において、オブジェクトのメンバ変数にアクセスせざるを得ないような場面は、 稀にではあるが発生する。 このような場合に適用するがのこのイデオムである。

    //  example/design_pattern/accessor_ut.cpp 28

    class A {  // Accessorの実装例
    public:
        void SetA(int32_t a) noexcept  // setter
        {
            a_ = a;
        }

        int32_t GetA() const noexcept  // getter
        {
            return a_;
        }

    private:
        int32_t a_{0};
        // ...
    };

    void f(A& a) noexcept
    {
        a.SetA(3);

        // Do something
        // ...
    }

メンバ変数への直接のアクセスに比べ、以下のようなメリットがある。

一方で、クラスに対するこのような細かい制御は、カプセル化に対して問題を起こしやすい。 下記はその典型的なアンチパターンである。

    //  example/design_pattern/accessor_ut.cpp 62

    class A {  // Accessorを使用して細かすぎる制御をしてしまうアンチパターン
    public:
        void SetA(int32_t a) noexcept  // setter
        {
            a_ = a;
        }

        int32_t GetA() const noexcept  // getter
        {
            return a_;
        }

        void Change(bool is_changed) noexcept  // setter
        {
            is_changed_ = is_changed;
        }

        bool IsChanged() const noexcept  // getter
        {
            return is_changed_;
        }

        void DoSomething() noexcept  // is_changed_がtrueの時に、呼び出してほしい
        {
            // Do something
            // ...
        }
        // ...
    };

    void f(A& a) noexcept
    {
        if (a.GetA() != 3) {
            a.SetA(3);
            a.Change(true);
        }

        // ...
    }

    void g(A& a) noexcept
    {
        if (!a.IsChanged()) {
            return;
        }

        a.Change(false);
        a.DoSomething();  // a.IsChanged()がtrueの時に実行する。

        // ...
    }

上記ソースコードは、オブジェクトaのA::a_が変更された場合、 その後、それをもとに何らかの動作を行うこと(a.DoSomething)を表しているが、 本来オブジェクトaの状態が変わったかどうかはオブジェクトa自体が判断すべきであり、 a.DoSomething()の実行においても、それが必要かどうかはオブジェクトaが判断すべきである。 この考えに基づいた修正ソースコードを下記に示す。

    //  example/design_pattern/accessor_ut.cpp 130

    class A {  // 上記アンチパターンからChange()とIsChanged()を削除し、状態の隠蔽レベルを強化
    public:
        void SetA(int32_t a) noexcept  // setter
        {
            if (a_ == a) {
                return;
            }

            a_          = a;
            is_changed_ = true;
        }

        void DoSomething() noexcept
        {
            if (!is_changed_) {
                return;
            }

            // Do something
            // ...

            is_changed_ = false;  // 状態変更の取り消し
        }
        // ...
    };

    void f(A& a) noexcept
    {
        a.SetA(3);

        // ...
    }

    void g(A& a) noexcept
    {
        a.DoSomething();  // DoSomethingは無条件で呼び出す。
                          // 実際に何かをするかどうかは、オブジェクトaが決める。
        // ...
    }

setterを使用する場合、上記のように処理の隠蔽化には特に気を付ける必要がある。

Copy-And-Swap

メンバ変数にポインタやスマートポインタを持つクラスに

が必要になった場合、コンパイラが生成するデフォルトの 特殊メンバ関数では機能が不十分であることが多い。

下記に示すコードは、そのような場合の上記4関数の実装例である。

    //  example/design_pattern/no_copy_and_swap_ut.cpp 8

    class NoCopyAndSwap final {
    public:
        explicit NoCopyAndSwap(char const* name0, char const* name1)
            : name0_{name0 == nullptr ? "" : name0}, name1_{name1 == nullptr ? "" : name1}
        {
        }

        NoCopyAndSwap(NoCopyAndSwap const& rhs) : name0_{rhs.name0_}, name1_{rhs.name1_} {}

        NoCopyAndSwap(NoCopyAndSwap&& rhs) noexcept
            : name0_{std::exchange(rhs.name0_, nullptr)}, name1_{std::move(rhs.name1_)}
        {
            // move後には、
            //  * name0_はnullptr
            //  * name1_はnullptrを保持したunique_ptr
            // となる。
        }

        NoCopyAndSwap& operator=(NoCopyAndSwap const& rhs)
        {
            if (this == &rhs) {
                return *this;
            }

            // copyコンストラクタのコードクローン
            name0_ = rhs.name0_;
            name1_ = rhs.name1_;  // ここでエクセプションが発生すると*thisが壊れる

            return *this;
        }

        NoCopyAndSwap& operator=(NoCopyAndSwap&& rhs) noexcept
        {
            if (this == &rhs) {
                return *this;
            }

            // moveコンストラクタのコードクローン
            name0_ = std::exchange(rhs.name0_, nullptr);
            name1_ = std::string{};  // これがないと、name1_の値がrhs.name1_にスワップされる
            name1_ = std::move(rhs.name1_);

            return *this;
        }

        char const*        GetName0() const noexcept { return name0_; }
        std::string const& GetName1() const noexcept { return name1_; }
        ~NoCopyAndSwap() = default;

    private:
        char const* name0_;  // 問題やその改善を明示するために、敢えてname0_をchar const*としたが、
                             // 本来ならば、std::stringかstd::string_viewを使うべき
        std::string name1_;
    };

コード内のコメントで示したように、このコードには以下のような問題がある。

ここで紹介するCopy-And-Swapはこのような問題を解決するためのイデオムである。

実装例を以下に示す。

    //  example/design_pattern/copy_and_swap_ut.cpp 6

    class CopyAndSwap final {
    public:
        explicit CopyAndSwap(char const* name0, char const* name1)
            : name0_{name0 == nullptr ? "" : name0}, name1_{name1 == nullptr ? "" : name1}
        {
        }

        CopyAndSwap(CopyAndSwap const& rhs) : name0_{rhs.name0_}, name1_{rhs.name1_} {}

        CopyAndSwap(CopyAndSwap&& rhs) noexcept : name0_{std::exchange(rhs.name0_, nullptr)}, name1_{std::move(rhs.name1_)}
        {
            // move後には、
            //  * name0_はnullptr
            //  * name1_は""を保持したstd::string
            // となる。
        }

        CopyAndSwap& operator=(CopyAndSwap const& rhs)
        {
            if (this == &rhs) {
                return *this;
            }

            // copyコンストラクタの使用
            CopyAndSwap tmp{rhs};  // ここでエクセプションが発生しても、tmp以外、壊れない

            Swap(tmp);

            return *this;
        }

        CopyAndSwap& operator=(CopyAndSwap&& rhs) noexcept
        {
            if (this == &rhs) {
                return *this;
            }

            CopyAndSwap tmp{std::move(rhs)};  // moveコンストラクタ

            Swap(tmp);

            return *this;
        }

        void Swap(CopyAndSwap& rhs) noexcept
        {
            std::swap(name0_, rhs.name0_);
            std::swap(name1_, rhs.name1_);
        }

        char const*        GetName0() const noexcept { return name0_; }
        std::string const& GetName1() const noexcept { return name1_; }
        ~CopyAndSwap() = default;

    private:
        char const* name0_;  // 問題やその改善を明示するために、敢えてname0_をchar const*としたが、
                             // 本来ならば、std::stringかstd::string_viewを使うべき
        std::string name1_;
    };

上記CopyAndSwapのcopyコンストラクタ、moveコンストラクタに変更はない。 また、CopyAndSwap::Swapに関してもstd::vector等が持つswapと同様のものである。 このイデオムの特徴は、copy代入演算子、 move代入演算子が各コンストラクタとSwap関数により実装されている所にある。 これによりエクセプション安全性の保証を持つ4関数をコードクローンすることなく実装できる。

Immutable

クラスに対するimmutable、immutabilityの定義を以下のように定める。

immutabilityが高いほど、そのクラスの使用方法は制限される。 これにより、そのクラスやそのクラスを使用しているソースコードの可読性やデバッグ容易性が向上する。 また、クラスがimmutableでなくても、そのクラスのオブジェクトをconstハンドル経由でアクセスすることで、 immutableとして扱うことができる。

一方で、「Accessor」で紹介したsetterは、クラスのimmutabilityを下げる。 いつでも状態が変更できるため、ソースコードの可読性やデバッグ容易性が低下する。 また、マルチスレッド環境においてはこのことが競合問題や、 それを回避するためのロックがパフォーマンス問題やデッドロックを引き起こしてしまう。

従って、クラスを宣言、定義する場合、immutabilityを出来るだけ高くするべきであり、 そのクラスのオブジェクトを使う側は、 可能な限りimmutableオブジェクト(constオブジェクト)として扱うべきである。

Clone(仮想コンストラクタ)

オブジェクトコピーによるスライシングを回避するためのイデオムである。

下記は、オブジェクトコピーによるスライシングを起こしてしまう例である。

    //  example/design_pattern/clone_ut.cpp 8

    class BaseSlicing {
    public:
        // ...
        virtual char const* Name() const noexcept { return "BaseSlicing"; }
    };

    class DerivedSlicing final : public BaseSlicing {
    public:
        // ...
        virtual char const* Name() const noexcept override { return "DerivedSlicing"; }
    };

    TEST(Clone, object_slicing)
    {
        auto b = BaseSlicing{};
        auto d = DerivedSlicing{};

        BaseSlicing* b_ptr   = &b;
        BaseSlicing* b_ptr_d = &d;

        ASSERT_STREQ("BaseSlicing", b_ptr->Name());
        ASSERT_STREQ("DerivedSlicing", b_ptr_d->Name());

        *b_ptr = *b_ptr_d;  // コピーしたつもりだがスライシングにより、*b_ptrは、
                            // DerivedSlicingのインスタンスではなく、BaseSlicingのインスタンス

    #if 0
        ASSERT_STREQ("DerivedSlicing", b_ptr->Name());
    #else
        ASSERT_STREQ("BaseSlicing", b_ptr->Name());  // "DerivedSlicing"が返るはずだが、
                                                     // スライシングにより"BaseSlicing"が返る
    #endif
    }

下記は、上記にcloneイデオムを適用した例である。

    //  example/design_pattern/clone_ut.cpp 50

    // スライシングを起こさないようにコピー演算子の代わりにClone()を実装。
    class BaseNoSlicing {
    public:
        // ...
        virtual char const* Name() const noexcept { return "BaseNoSlicing"; }

        virtual std::unique_ptr<BaseNoSlicing> Clone() { return std::make_unique<BaseNoSlicing>(); }

        BaseNoSlicing(BaseNoSlicing const&)            = delete;  // copy生成の禁止
        BaseNoSlicing& operator=(BaseNoSlicing const&) = delete;  // copy代入の禁止
    };

    class DerivedNoSlicing final : public BaseNoSlicing {
    public:
        // ...
        virtual char const* Name() const noexcept override { return "DerivedNoSlicing"; }

        std::unique_ptr<DerivedNoSlicing> CloneOwn() { return std::make_unique<DerivedNoSlicing>(); }

        // DerivedNoSlicingはBaseNoSlicingの派生クラスであるため、
        // std::unique_ptr<DerivedNoSlicing>オブジェクトから
        // std::unique_ptr<BaseNoSlicing>オブジェクトへのmove代入可能
        virtual std::unique_ptr<BaseNoSlicing> Clone() override { return CloneOwn(); }
    };

    TEST(Clone, object_slicing_avoidance)
    {
        auto b = BaseNoSlicing{};
        auto d = DerivedNoSlicing{};

        BaseNoSlicing* b_ptr   = &b;
        BaseNoSlicing* b_ptr_d = &d;

        ASSERT_STREQ("BaseNoSlicing", b_ptr->Name());
        ASSERT_STREQ("DerivedNoSlicing", b_ptr_d->Name());

    #if 0
        *b_ptr = *b_ptr_d;                // コピー演算子をdeleteしたのでコンパイルエラー
    #else
        auto b_uptr = b_ptr_d->Clone();              // コピー演算子の代わりにClone()を使う。
    #endif

        ASSERT_STREQ("DerivedNoSlicing", b_uptr->Name());  // 意図通り"DerivedNoSlicing"が返る。
    }

B1::Clone()やそのオーバーライドであるD1::Clone()を使うことで、 スライシングを起こすことなくオブジェクトのコピーを行うことができるようになった。

NVI(non virtual interface)

NVIとは、「virtualなメンバ関数をpublicにしない」という実装上の制約である。

下記のようにクラスBaseが定義されているとする。

    //  example/design_pattern/nvi_ut.cpp 7

    class Base {
    public:
        virtual bool DoSomething(int something) const noexcept
        {
            // ...
        }

        virtual ~Base() = default;

    private:
        // ...
    };

これを使うクラスはBase::DoSomething()に依存する。 また、このクラスから派生した下記のクラスDerivedもBase::DoSomething()に依存する。

    //  example/design_pattern/nvi_ut.cpp 26

    class Derived : public Base {
    public:
        virtual bool DoSomething(int something) const noexcept override
        {
            // ...
        }

    private:
        // ...
    };

この条件下ではBase::DoSomething()へ依存が集中し、この関数の修正や機能追加の作業コストが高くなる。 このイデオムは、この問題を軽減する。

これを用いた上記2クラスのリファクタリング例を以下に示す。

    //  example/design_pattern/nvi_ut.cpp 57

    class Base {
    public:
        bool DoSomething(int something) const noexcept { return do_something(something); }
        virtual ~Base() = default;

    private:
        virtual bool do_something(int something) const noexcept
        {
            // ...
        }

        // ...
    };

    class Derived : public Base {
    private:
        virtual bool do_something(int something) const noexcept override
        {
            // ...
        }

        // ...
    };

オーバーライド元の関数とそのオーバーライドのデフォルト引数の値は一致させる必要がある。

それに従わない下記のようなクラスとその派生クラス

    //  example/design_pattern/nvi_ut.cpp 105

    class NotNviBase {
    public:
        virtual std::string Name(bool mangled = false) const { return mangled ? typeid(*this).name() : "NotNviBase"; }

        virtual ~NotNviBase() = default;
    };

    class NotNviDerived : public NotNviBase {
    public:
        virtual std::string Name(bool mangled = true) const override  // NG デフォルト値が違う
        {
            return mangled ? typeid(*this).name() : "NotNviDerived";
        }
    };

には下記の単体テストで示したような、 メンバ関数の振る舞いがその表層型に依存してしまう問題を持つことになる。

    //  example/design_pattern/nvi_ut.cpp 126

    NotNviDerived const d;
    NotNviBase const&   d_ref = d;

    ASSERT_EQ("NotNviDerived", d.Name(false));   // OK
    ASSERT_EQ("13NotNviDerived", d.Name(true));  // OK

    ASSERT_EQ("NotNviDerived", d_ref.Name(false));   // OK
    ASSERT_EQ("13NotNviDerived", d_ref.Name(true));  // OK

    ASSERT_EQ("13NotNviDerived", d.Name());    // mangled == false
    ASSERT_EQ("NotNviDerived", d_ref.Name());  // mangled == true

    ASSERT_NE(d.Name(), d_ref.Name());  // NG d_refの実態はdであるが、d.Name()と動きが違う

この例のように継承階層が浅く、デフォルト引数の数も少ない場合、 この値を一致させることは難しくないが、 これよりも遥かに複雑な実際のコードではこの一致の維持は困難になる。

下記のようにNVIに従わせることでこのような問題に対処できる。

    //  example/design_pattern/nvi_ut.cpp 145
    class NviBase {
    public:
        std::string Name(bool mangled = false) const { return name(mangled); }
        virtual ~NviBase() = default;

    private:
        virtual std::string name(bool mangled) const { return mangled ? typeid(*this).name() : "NviBase"; }
    };

    class NviDerived : public NviBase {
    private:
        virtual std::string name(bool mangled) const override  // OK デフォルト値を持たない
        {
            return mangled ? typeid(*this).name() : "NviDerived";
        }
    };

下記の単体テストにより、この問題の解消が確認できる。

    //  example/design_pattern/nvi_ut.cpp 167

    NviBase const    b;
    NviDerived const d;
    NviBase const&   d_ref = d;

    ASSERT_EQ("NviDerived", d.Name(false));   // OK
    ASSERT_EQ("10NviDerived", d.Name(true));  // OK

    ASSERT_EQ("NviDerived", d_ref.Name(false));   // OK
    ASSERT_EQ("10NviDerived", d_ref.Name(true));  // OK

    ASSERT_EQ("NviDerived", d.Name());      // mangled == false
    ASSERT_EQ("NviDerived", d_ref.Name());  // mangled == false

    ASSERT_EQ(d.Name(), d_ref.Name());  // OK

なお、メンバ関数のデフォルト引数は、 そのクラス外部からのメンバ関数呼び出しを簡潔に記述するための記法であるため、 privateなメンバ関数はデフォルト引数を持つべきではない。

RAII(scoped guard)

RAIIとは、「Resource Acquisition Is Initialization」の略語であり、 リソースの確保と解放をオブジェクトの初期化と破棄処理に結びつけるパターンもしくはイデオムである。 特にダイナミックにオブジェクトを生成する場合、 RAIIに従わないとメモリリークを防ぐことは困難である。

下記は、関数終了付近でdeleteする素朴なコードである。

    //  example/design_pattern/raii_ut.cpp 19

    // Aは外部の変数をリファレンスcounter_として保持し、
    //  * コンストラクタ呼び出し時に++counter_
    //  * デストラクタタ呼び出し時に--counter_
    // とするため、生成と解放が同じだけ行われれば外部の変数の値は0となる
    class A {
    public:
        A(uint32_t& couner) noexcept : counter_{++couner} {}
        ~A() { --counter_; }

    private:
        uint32_t& counter_;
    };

    char not_use_RAII_for_memory(size_t index, uint32_t& object_counter)
    {
        auto a = new A{object_counter};  // RAIIでない例
        auto s = std::string{"hehe"};

        auto ret = s.at(index);  // index >= 5でエクセプション発生

        // 何らかの処理

        delete a;         //  この行以前に関数を抜けるとaはメモリリーク

        return ret;
    }

このコードは下記の単体テストが示す通り、第1パラメータが5以上の場合、 エクセプションが発生しメモリリークしてしまう。

    //  example/design_pattern/raii_ut.cpp 72

    auto object_counter = 0U;

    // 第1引数が5なのでエクセプション発生
    ASSERT_THROW(not_use_RAII_for_memory(5, object_counter), std::exception);

    // 上記のnot_use_RAII_for_memoryではエクセプションが発生し、メモリリークする
    ASSERT_EQ(1, object_counter);

以下は、std::unique_ptrによってRAIIを導入し、この問題に対処した例である。

    //  example/design_pattern/raii_ut.cpp 84

    char use_RAII_for_memory(size_t index, uint32_t& object_counter)
    {
        auto a = std::make_unique<A>(object_counter);
        auto s = std::string{"hehe"};

        auto ret = s.at(index);  // index >= 5でエクセプション発生

        // 何らかの処理

        return ret;  // aは自動解放される
    }

下記単体テストで確認できるように、 エクセプション発生時にもstd::unique_ptrによる自動解放によりメモリリークは発生しない。

    //  example/design_pattern/raii_ut.cpp 101

    auto object_counter = 0U;

    // 第1引数が5なのでエクセプション発生
    ASSERT_THROW(use_RAII_for_memory(5, object_counter), std::exception);

    // 上記のuse_RAII_for_memoryではエクセプションが発生するがメモリリークはしない
    ASSERT_EQ(0, object_counter);

RAIIのテクニックはメモリ管理のみでなく、ファイルディスクリプタ(open-close、socket-close) 等のリソース管理においても有効であるという例を示す。

下記は、生成したソケットを関数終了付近でcloseする素朴なコードである。

    //  example/design_pattern/raii_ut.cpp 112

    // RAIIをしない例
    // 複数のclose()を書くような関数は、リソースリークを起こしやすい。
    void not_use_RAII_for_socket()
    {
        auto fd = socket(AF_INET, SOCK_STREAM, 0);

        try {
            // Do something
            // ...
        }
        catch (std::exception const& e) {  // エクセプションはconstリファレンスで受ける。
            close(fd);                     // NG RAII未使用
            // Do something to recover
            // ...

            return;
        }
        // ...
        close(fd);  // NG RAII未使用
    }

エクセプションを扱うために関数の2か所でソケットをcloseしている。 この程度であれば大きな問題にはならないだろうが、実際には様々な条件が重なるため、 リソースの解放コードは醜悪にならざるを得ない。

このような場合には、下記するようなリソース解放用クラス

    //  h/scoped_guard.h 7

    /// @brief RAIIのためのクラス。コンストラクタ引数の関数オブジェクトをデストラクタから呼び出す
    ///
    #if __cplusplus >= 202002L   // c++20

    template <std::invocable F>  // Fが呼び出し可能であることを制約
    #else  // c++17

    template <typename F>
    #endif
    class ScopedGuard {
    public:
        explicit ScopedGuard(F&& f) noexcept : f_{f}
        {
        }

        ~ScopedGuard() { f_(); }
        ScopedGuard(ScopedGuard const&)            = delete;  // copyは禁止
        ScopedGuard& operator=(ScopedGuard const&) = delete;  // copyは禁止

    private:
        F f_;
    };

を使用し、下記のようにすることで安全なコードをすっきりと書くことができる。

    //  example/design_pattern/raii_ut.cpp 139

    // RAIIをScopedGuardで行った例。
    // close()が自動実行されるためにリソース解放を忘れない。
    void use_RAII_for_socket()
    {
        auto fd    = socket(AF_INET, SOCK_STREAM, 0);
        auto guard = ScopedGuard{[fd] { close(fd); }};  // 関数終了時に自動実行

        try {
            // Do something
        }
        catch (...) {
            // Do something to recover

            return;
        }

        // Do something
    }

クリティカルセクションの保護をlock/unlockで行うstd::mutex等を使う場合にも、 std::lock_guard<>によってunlockを行うことで、同様の効果が得られる。

Future

Futureとは、 並行処理のためのデザインパターンであり、別スレッドに何らかの処理をさせる際、 その結果の取得を、必要になるまで後回しにする手法である。

C++11では、std::future, std::promise, std::asyncによって実現できる。

まずは、C++03以前のスタイルから示す。

    //  example/design_pattern/future_ut.cpp 11

    int do_something(std::string_view str0, std::string_view str1) noexcept
    {
        // ...

        return ret0 + ret1;
    }

    TEST(Future, old_style)
    {
        auto str0 = std::string{};
        auto th0  = std::thread{[&str0]() noexcept { str0 = do_heavy_algorithm("thread 0"); }};

        auto str1 = std::string{};
        auto th1  = std::thread{[&str1]() noexcept { str1 = do_heavy_algorithm("thread 1"); }};

        //
        // このスレッドで行うべき何らかの処理
        //

        th0.join();
        th1.join();

        ASSERT_EQ("THREAD 0", str0);
        ASSERT_EQ("THREAD 1", str1);

        ASSERT_EQ(16, do_something(str0, str1));
    }

上記は、

  1. 時間がかかる処理を並行して行うために、スレッドを二つ作る。
  2. それぞれの完了をthread::join()で待ち合わせる。
  3. その結果を参照キャプチャによって受け取る。
  4. その2つの結果を別の関数に渡す。

という処理を行っている。

この程度の単純なコードでは特に問題にはならないが、目的外の処理が多いことがわかるだろう。

次にFutureパターンによって上記をリファクタリングした例を示す。

    //  example/design_pattern/future_ut.cpp 45

    TEST(Future, new_style)
    {
        std::future<std::string> result0
            = std::async(std::launch::async, []() noexcept { return do_heavy_algorithm("thread 0"); });

        std::future<std::string> result1
            = std::async(std::launch::async, []() noexcept { return do_heavy_algorithm("thread 1"); });

        // futre::get()は処理の待ち合わせと値の取り出しを行う。
        auto str0 = result0.get();
        auto str1 = result1.get();
        ASSERT_EQ(16, do_something(str0, str1));

        ASSERT_EQ("THREAD 0", str0);
        ASSERT_EQ("THREAD 1", str1);
    }

リファクタリングした例では、時間のかかる処理をstd::future型のオブジェクトにし、 その結果を必要とする関数に渡すことができるため、目的をよりダイレクトに表すことができる。

なお、

    std::async(関数オブジェクト)

という形式を使った場合、関数オブジェクトは、

    std::launch::async | std::launch::deferred

が指定されたとして実行される。この場合、

    std::launch::deferred

の効果により、関数オブジェクトは、並行に実行されるとは限らない (この仕様はランタイム系に依存しており、std::future::get()のコンテキストで実行されることもあり得る)。 従って、並行実行が必要な場合、上記例のように

    std::launch::async

のみを明示的に指定するべきである。

DI(dependency injection)

メンバ関数内でクラスDependedのオブジェクトを直接、生成する (もしくはSingletonオブジェクトや静的オブジェクト(std::coutやstd::cin等)に直接アクセスする) クラスNotDIがあるとする。 この場合、クラスNotDIはクラスDependedのインスタンスに依存してしまう。 このような依存関係はクラスNotDIの可用性とテスト容易性を下げる。 これは、「仮にクラスDependedがデータベースをラップするクラスだった場合、 クラスNotDIの単体テストにデータベースが必要になる」ことからも容易に理解できる。

    //  example/design_pattern/di_ut.cpp 8

    /// @brief NotDIや、DIから依存されるクラス
    class Depended {
        // ...
    };

    /// @brief NotDIを使わない例。そのため、NotDIは、Dependedのインスタンスに依存している。
    class NotDI {
    public:
        NotDI() : not_di_depended_{std::make_unique<Depended>()} {}

        void DoSomething() { not_di_depended_->DoSomething(); }

    private:
        std::unique_ptr<Depended> not_di_depended_;
    };

下記は上記NotDIにDIパターンを適用した例である。 この場合、クラスDIは、クラスDependedの型にのみ依存する。

    //  example/design_pattern/di_ut.cpp 37

    /// @brief DIを使う例。そのため、DIは、Dependedの型に依存している。
    class DI {
    public:
        explicit DI(std::unique_ptr<Depended>&& di_depended) noexcept : di_depended_{std::move(di_depended)} {}

        void DoSomething() { di_depended_->DoSomething(); }

    private:
        std::unique_ptr<Depended> di_depended_;
    };

下記は、クラスNotDIとクラスDIがそれぞれのDoSomething()を呼び出すまでのシーケンス図である。

このパターンの効果により、 DIオブジェクトにはDependedかその派生クラスのオブジェクトを渡すことができるようになった。 これによりクラスDIは拡張性に対して柔軟になっただけでなく、テスト容易性も向上した。

次に示すのは、このパターンを使用して問題のある単体テストを修正した例である。

まずは、問題があるクラスとその単体テストを下記する。

    // in device_io.h

    class DeviceIO {
    public:
        uint8_t read()
        {
            // ハードウェアに依存した何らかの処理
        }

        void write(uint8_t a)
        {
            // ハードウェアに依存した何らかの処理
        }

    private:
        // 何らかの宣言
    };

    #ifdef UNIT_TEST       // 単体テストビルドでは定義されるマクロ
    class DeviceIO_Mock {  // 単体テスト用のモック
    public:
        uint8_t read()
        {
            // ハードウェアに依存しない何らかの処理
        }

        void write(uint8_t a)
        {
            // ハードウェアに依存しない何らかの処理
        }

    private:
        // 何らかの宣言
    };
    #endif
    // in widget.h
    
    #include "device_io.h"

    class Widget {
    public:
        void DoSomething()
        {
            // io_を使った何らかの処理
        }

        uint8_t GetResp()
        {
            // io_を使った何らかの処理
        }

    private:
    #ifdef UNIT_TEST
        DeviceIO_Mock io_;
    #else
        DeviceIO io_;
    #endif
    };
    // in widget_ut.cpp

    // UNIT_TESTマクロが定義されたWidgetの単体テスト
    Widget w;

    w.DoSomething();
    ASSERT_EQ(0, w.GetResp());

当然であるが、この単体テストは、UNIT_TESTマクロを定義している場合のWidgetの評価であり、 UNIT_TESTを定義しない実際のコードの評価にはならない。

以下では、DIを用い、この問題を回避する。

    // in device_io.h

    class DeviceIO {
    public:
        virtual uint8_t read()  // モックでオーバーライドするためvirtual
        {
            // ハードウェアに依存した何らかの処理
        }

        virtual void write(uint8_t a)  // モックでオーバーライドするためvirtual
        {
            // ハードウェアに依存した何らかの処理
        }
        virtual ~DeviceIO() = default;

    private:
        // 何らかの宣言
    };
    // in widget.h

    class Widget {
    public:
        Widget(std::unique_ptr<DeviceIO> io = std::make_unique<DeviceIO>()) : io_{std::move(io)} {}

        void DoSomething()
        {
            // io_を使った何らかの処理
        }

        uint8_t GetResp()
        {
            // io_を使った何らかの処理
        }

    private:
        std::unique_ptr<DeviceIO> io_;
    };
    // in widget_ut.cpp

    class DeviceIO_Mock : public DeviceIO {  // 単体テスト用のモック
    public:
        uint8_t read() override
        {
            // ハードウェアに依存しない何らかの処理
        }

        void write(uint8_t a) override
        {
            // ハードウェアに依存しない何らかの処理
        }

    private:
        // 何らかの宣言
    };
    // 上記DeviceIO_Mockと同様に、in widget_ut.cpp

    Widget w{std::unique_ptr<DeviceIO>(new DeviceIO_Mock)};  // モックのインジェクション

    // Widgetの単体テスト
    w.DoSomething();
    ASSERT_EQ(1, w.GetResp());

この例では、単体テストのためだけに仮想関数を導入しているため、多少やりすぎの感がある。 そのような場合、下記のようにテンプレートを用いればよい。

    // in device_io.h

    class DeviceIO {
    public:
        uint8_t read()  // Widgetがテンプレートであるため非virtualで良い
        {
            // ハードウェアに依存した何らかの処理
        }

        void write(uint8_t a)  // Widgetがテンプレートであるため非virtualで良い
        {
            // ハードウェアに依存した何らかの処理
        }
        virtual ~DeviceIO() = default;

    private:
        // 何らかの宣言
    };
    // in widget.h

    template <class T = DeviceIO>
    class Widget {
    public:
        void DoSomething()
        {
            // io_を使った何らかの処理
        }

        uint8_t GetResp()
        {
            // io_を使った何らかの処理
        }

    private:
        T io_;
    };
    // in widget_ut.cpp

    class DeviceIO_Mock {  // 単体テスト用のモック
    public:
        uint8_t read()  // Widgetがテンプレートであるため非virtualで良い
        {
            // ハードウェアに依存しない何らかの処理
        }

        void write(uint8_t a)  // Widgetがテンプレートであるため非virtualで良い
        {
            // ハードウェアに依存しない何らかの処理
        }

    private:
        // 何らかの宣言
    };
    // 上記DeviceIO_Mockと同様に、in widget_ut.cpp

    Widget<DeviceIO_Mock> w;

    // Widget<>の単体テスト
    w.DoSomething();
    ASSERT_EQ(2, w.GetResp());

以上からわかるように、 ここで紹介したDIは単体テストを容易にするクラス設計のためにも非常に有用なパターンである。

Singleton

このパターンにより、特定のクラスのインスタンスをシステム全体で唯一にすることができる。 これにより、グローバルオブジェクトを規律正しく使用しやすくなる。

以下は、Singletonの実装例である。

    //  example/design_pattern/singleton_ut.cpp 7

    class Singleton final {
    public:
        static Singleton&       Inst();
        static Singleton const& InstConst() noexcept  // constインスタンスを返す
        {
            return Inst();
        }
        // ...

    private:
        Singleton() noexcept {}  // コンストラクタをprivateにすることで、
                                 // Inst()以外ではこのオブジェクトを生成できない。
        // ...
    };

    Singleton& Singleton::Inst()
    {
        static Singleton inst;  //  instの初期化が同時に行われることはない。

        return inst;
    }

    TEST(Singleton, how_to_use)
    {
        auto&       inst       = Singleton::Inst();
        auto const& inst_const = Singleton::InstConst();

        ASSERT_EQ(0, inst.GetXxx());
        ASSERT_EQ(0, inst_const.GetXxx());
    #if 0
        inst_const.SetXxx(10);  // inst_constはconstオブジェクトなのでコンパイルエラー
    #else
        inst.SetXxx(10);
    #endif
        ASSERT_EQ(10, inst.GetXxx());
        ASSERT_EQ(10, inst_const.GetXxx());

        inst.SetXxx(0);
        ASSERT_EQ(0, inst.GetXxx());
        ASSERT_EQ(0, inst_const.GetXxx());
    }
    }  // namespace

このパターンを使用する場合、以下に注意する。

Singletonオブジェクトの初期化(最初のコンストラクタ呼び出し)は、 C++03以前はスレッドセーフでなかったため、「 Double Checked Lockingを使って競合を避ける」か、 「他のスレッドを起動する前にメインスレッドから各SingletonのInstConst()を呼び出す」 ことが必要であった。 C++11から上記例のようなSingletonオブジェクトのコンストラクタ呼び出しはスレッドセーフとなったため、 このような黒魔術が不要になった。

なお、Inst()のような関数を複数定義する場合、そのパターンはNamed Constructor (「Named Constructor」参照)と呼ばれる。

State

Stateは、オブジェクトの状態と、それに伴う振る舞いを分離して記述するためのパターンである。 これにより状態の追加、削減、変更に伴う修正範囲が限定される (「オープン・クローズドの原則(OCP)」参照)。 またオブジェクトのインターフェース変更(パブリックメンバ関数の変更)に関しても、修正箇所が明確になる。

上記ステートマシン図の「オールドスタイルによる実装」と、「stateパターンによる実装」、 それぞれを例示する。

まずは、下記にオールドスタイルな実装例を示す。 この実装では、状態を静的なenum変数thread_old_style_stateで管理するため、 ThreadOldStyleStateStr()、ThreadOldStyleRun()、ThreadOldStyleAbort()、ThreadOldStyleSuspend() には、thread_old_style_stateに対する同型のswitch文が入ることになる(下記例では一部省略)。 これは醜悪で、バグを起こしやすい構造である。 ただし、要求される状態遷移がこの例程度であり、状態ごとに決められた振る舞いの数が少なければ、 この構造でも問題ないともいえる。

    //  example/design_pattern/state_machine_old.h 4

    extern std::string_view ThreadOldStyleStateStr() noexcept;
    extern void             ThreadOldStyleRun();
    extern void             ThreadOldStyleAbort();
    extern void             ThreadOldStyleSuspend();
    //  example/design_pattern/state_machine_old.cpp 6

    namespace {
    enum class ThreadOldStyleState {
        Idle,
        Running,
        Suspending,
    };

    ThreadOldStyleState thread_old_style_state;
    // ...
    }  // namespace

    std::string_view ThreadOldStyleStateStr() noexcept
    {
        switch (thread_old_style_state) {  // このswitch文と同型switch文が何度も記述される
        case ThreadOldStyleState::Idle:
            return "Idle";
        case ThreadOldStyleState::Running:
            return "Running";
        case ThreadOldStyleState::Suspending:
            return "Suspending";
        default:
            assert(false);
            return "";
        }
    }

    void ThreadOldStyleRun()
    {
        switch (thread_old_style_state) {
        case ThreadOldStyleState::Idle:
        case ThreadOldStyleState::Running:
            thread_old_style_state = ThreadOldStyleState::Running;
            break;
        case ThreadOldStyleState::Suspending:
            --thread_old_style_suspend_count;
            if (thread_old_style_suspend_count == 0) {
                thread_old_style_state = ThreadOldStyleState::Running;
            }
            break;
        default:
            assert(false);
        }
    }

    void ThreadOldStyleAbort()
    {
        // ...
    }

    void ThreadOldStyleSuspend()
    {
        // ...
    }
    //  example/design_pattern/state_machine_ut.cpp 15

    // ステートのテスト。仕様書よりも単体テストでその仕様や使用法を記述したほうが正確に理解できる。
    TEST(StateMachine, old_style)
    {
        ASSERT_EQ("Idle", ThreadOldStyleStateStr());

        ThreadOldStyleAbort();
        ASSERT_EQ("Idle", ThreadOldStyleStateStr());

        ThreadOldStyleRun();
        ASSERT_EQ("Running", ThreadOldStyleStateStr());

        ThreadOldStyleRun();
        ASSERT_EQ("Running", ThreadOldStyleStateStr());

        ThreadOldStyleSuspend();
        ASSERT_EQ("Suspending", ThreadOldStyleStateStr());  // suspend_count_ == 1

        ThreadOldStyleSuspend();
        ASSERT_EQ("Suspending", ThreadOldStyleStateStr());  // suspend_count_ == 2

        ThreadOldStyleRun();
        ASSERT_EQ("Suspending", ThreadOldStyleStateStr());  // suspend_count_ == 1

        // ...
    }

下記は、上記例へstateパターンを適用した例である。 まずは、stateパターンを形成するクラスの関係をクラス図で示す。

次に上記クラス図の実装例を示す。

    //  example/design_pattern/state_machine_new.h 6

    /// @brief ThreadNewStyleのステートを表す基底クラス
    class ThreadNewStyleState {
    public:
        ThreadNewStyleState()          = default;
        virtual ~ThreadNewStyleState() = default;

        std::unique_ptr<ThreadNewStyleState> Abort()  // NVI
        {
            return abort_thread();
        }

        std::unique_ptr<ThreadNewStyleState> Run()  // NVI
        {
            return run_thread();
        }

        std::unique_ptr<ThreadNewStyleState> Suspend()  // NVI
        {
            return suspend_thread();
        }

        std::string_view GetStateStr() const noexcept { return get_state_str(); }

    private:
        virtual std::unique_ptr<ThreadNewStyleState> abort_thread()
        {
            return {};  // デフォルトでは何もしない。
        }

        virtual std::unique_ptr<ThreadNewStyleState> run_thread()
        {
            return {};  // デフォルトでは何もしない。
        }

        virtual std::unique_ptr<ThreadNewStyleState> suspend_thread()
        {
            return {};  // デフォルトでは何もしない。
        }

        virtual std::string_view get_state_str() const noexcept = 0;
    };
    //  example/design_pattern/state_machine_new.h 51

    class ThreadNewStyle final {
    public:
        ThreadNewStyle();

        void Abort() { change_state(state_->Abort()); }

        void Run() { change_state(state_->Run()); }

        void Suspend() { change_state(state_->Suspend()); }

        std::string_view GetStateStr() const noexcept { return state_->GetStateStr(); }

    private:
        std::unique_ptr<ThreadNewStyleState> state_;

        void change_state(std::unique_ptr<ThreadNewStyleState>&& new_state) noexcept
        {
            if (new_state) {
                state_ = std::move(new_state);
            }
        }
    };
    //  example/design_pattern/state_machine_new.cpp 10

    class ThreadNewStyleState_Idle final : public ThreadNewStyleState {
        // ...
    };

    class ThreadNewStyleState_Running final : public ThreadNewStyleState {
        // ...
    };

    class ThreadNewStyleState_Suspending final : public ThreadNewStyleState {
    public:
        // ...
    private:
        virtual std::unique_ptr<ThreadNewStyleState> abort_thread() override
        {
            // do something to abort
            // ...

            return std::make_unique<ThreadNewStyleState_Idle>();
        }

        virtual std::unique_ptr<ThreadNewStyleState> run_thread() override
        {
            --suspend_count_;

            if (suspend_count_ == 0) {
                // do something to resume
                // ...
                return std::make_unique<ThreadNewStyleState_Running>();
            }
            else {
                return {};
            }
        }

        virtual std::unique_ptr<ThreadNewStyleState> suspend_thread() override
        {
            ++suspend_count_;

            return {};
        }
        // ...
    };
    //  example/design_pattern/state_machine_ut.cpp 57

    TEST(StateMachine, new_style)
    {
        auto tns = ThreadNewStyle{};

        ASSERT_EQ("Idle", tns.GetStateStr());

        tns.Abort();
        ASSERT_EQ("Idle", tns.GetStateStr());

        tns.Run();
        ASSERT_EQ("Running", tns.GetStateStr());

        tns.Run();
        ASSERT_EQ("Running", tns.GetStateStr());

        tns.Suspend();
        ASSERT_EQ("Suspending", tns.GetStateStr());  // suspend_count_ == 1

        tns.Suspend();
        ASSERT_EQ("Suspending", tns.GetStateStr());  // suspend_count_ == 2

        tns.Run();
        ASSERT_EQ("Suspending", tns.GetStateStr());  // suspend_count_ == 1

        // ...
    }

オールドスタイルな構造に比べると一見複雑に見えるが同型のswitch構造がないため、 状態の増減や振る舞いの変更等への対応が容易である。 一方で、前述したとおり、この例程度の要求であれば、 シンプルさという意味においてオールドスタイルのソースコードの方が優れているともいえる。 従って、オールドスタイルとstateパターンの選択は、 その要求の複雑さと安定度によって決定されるべきものである。

なお、C++でのstateパターンの実装には、下記に示すようなメンバ関数を使う方法もある。 多くのクラスを作る必要はないが、 各状態での状態管理変数を別の状態のものと分けて管理することができないため、 複雑な状態管理が必要な場合には使えないが、単純な状態管理で十分な場合には便利なパターンである。

    //  example/design_pattern/state_machine_new.h 76

    class ThreadNewStyle2 final {
    public:
        ThreadNewStyle2() noexcept {}

        void             Abort() { (this->*abort_)(); }
        void             Run() { (this->*run_)(); }
        void             Suspend() { (this->*suspend_)(); }
        std::string_view GetStateStr() const noexcept { return state_str_; }

    private:
        void (ThreadNewStyle2::*abort_)()   = &ThreadNewStyle2::abort_idle;
        void (ThreadNewStyle2::*run_)()     = &ThreadNewStyle2::run_idle;
        void (ThreadNewStyle2::*suspend_)() = &ThreadNewStyle2::suspend_idle;
        std::string_view state_str_{state_str_idle_};

        void                                 abort_idle() {}  // do nothing
        void                                 run_idle();
        void                                 suspend_idle() {}  // do nothing
        static inline std::string_view const state_str_idle_{"Idle"};

        void                                 abort_running();
        void                                 run_running() {}  // do nothing
        void                                 suspend_running();
        static inline std::string_view const state_str_running_{"Running"};

        void                                 abort_suspending();
        void                                 run_suspending();
        void                                 suspend_suspending() {}  // do nothing
        static inline std::string_view const state_str_suspending_{"Suspending"};
    };
    //  example/design_pattern/state_machine_new.cpp 106

    void ThreadNewStyle2::run_idle()
    {
        // スレッドの始動処理
        // ...

        // ステートの切り替え
        run_       = &ThreadNewStyle2::run_running;
        suspend_   = &ThreadNewStyle2::suspend_running;
        state_str_ = state_str_running_;
    }

    void ThreadNewStyle2::abort_running()
    {
        // スレッドのアボート処理
        // ...

        // ステートの切り替え
        run_       = &ThreadNewStyle2::run_idle;
        suspend_   = &ThreadNewStyle2::suspend_idle;
        state_str_ = state_str_idle_;
    }

    void ThreadNewStyle2::suspend_running()
    {
        // スレッドのサスペンド処理
        // ...

        // ステートの切り替え
        run_       = &ThreadNewStyle2::run_suspending;
        suspend_   = &ThreadNewStyle2::suspend_suspending;
        state_str_ = state_str_suspending_;
    }

    void ThreadNewStyle2::run_suspending()
    {
        // スレッドのレジューム処理
        // ...

        // ステートの切り替え
        run_       = &ThreadNewStyle2::run_running;
        suspend_   = &ThreadNewStyle2::suspend_running;
        state_str_ = state_str_running_;
    }
    //  example/design_pattern/state_machine_ut.cpp 95

    TEST(StateMachine, new_style2)
    {
        auto tns = ThreadNewStyle2{};

        ASSERT_EQ("Idle", tns.GetStateStr());

        tns.Run();
        ASSERT_EQ("Running", tns.GetStateStr());

        tns.Suspend();
        ASSERT_EQ("Suspending", tns.GetStateStr());

        tns.Suspend();
        ASSERT_EQ("Suspending", tns.GetStateStr());
    }

Null Object

オブジェクトへのポインタを受け取った関数が 「そのポインタがnullptrでない場合、そのポインタが指すオブジェクトに何かをさせる」 というような典型的な条件文を削減するためのパターンである。

    //  example/design_pattern/null_object_ut.cpp 7

    class A {
    public:
        // ...
        bool Action() noexcept
        {
            // do something
            // ...
            return result;
        }
        // ...
    };

    bool ActionOldStyle(A* a) noexcept
    {
        if (a != nullptr) {  // ←このif文を消すためのパターン。
            return a->Action();
        }
        else {
            return false;
        }
    }

上記例にNull Objectパターンを適用した例を下記する。

    //  example/design_pattern/null_object_ut.cpp 41

    class A {
    public:
        // ...
        bool Action() noexcept { return action(); }

    private:
        virtual bool action() noexcept
        {
            // do something
            // ...
            return result;
        }
        // ...
    };

    class ANull final : public A {
        // ...
    private:
        virtual bool action() noexcept override { return false; }
    };

    bool ActionNewStyle(A& a) noexcept
    {
        return a.Action();  // ←Null Objectによりif文が消えた。
    }

この単純な例では、逆にソースコードが複雑化したように見えるが、

    if(a != nullptr)

を頻繁に使うような関数、 クラスではソースコードの単純化やnullptrチェック漏れの防止に非常に有効である。

Templateメソッド

Templateメソッドは、雛形の形式(書式等)を定めるメンバ関数(templateメソッド)と、 それを埋めるための振る舞いやデータを定めるメンバ関数を分離するときに用いるパターンである。

以下に実装例を示す。

    //  example/design_pattern/template_method.h 6

    /// @brief 何かのデータを入れる箱
    struct XxxData {
        int a;
        int b;
        int c;
    };

    /// @brief data_storer_if.cppに定義すべきだが、サンプルであるため便宜上同じファイルで定義する
    ///        データフォーマットを行うクラスのインターフェースクラス
    class XxxDataFormatterIF {
    public:
        explicit XxxDataFormatterIF(std::string_view formatter_name) noexcept : formatter_name_{formatter_name} {}
        virtual ~XxxDataFormatterIF() = default;

        std::string ToString(XxxData const& xxx_data) const { return header() + body(xxx_data) + footer(); }

        std::string ToString(std::vector<XxxData> const& xxx_datas) const
        {
            std::string ret{header()};

            for (auto const& xxx_data : xxx_datas) {
                ret += body(xxx_data);
            }

            return ret + footer();
        }
        // ...
    private:
        virtual std::string const& header() const                      = 0;
        virtual std::string const& footer() const                      = 0;
        virtual std::string        body(XxxData const& xxx_data) const = 0;

        // ...
    };

上記XxxDataFormatterIFでは、以下のようなメンバ関数を宣言、定義している。

メンバ関数 振る舞い
header() private pure-virtual ヘッダをstd::stringオブジェクトとして生成
footer() private pure-virtual フッタをstd::stringオブジェクトとして生成
body() private pure-virtual XxxDataからボディをstd::stringオブジェクトとして生成
ToString() public normal header(),body(),footer()の出力を組み合わせた全体像を生成

この構造により、XxxDataFormatterIFは、

下記XxxDataFormatterXml、XxxDataFormatterCsv、XxxDataFormatterTableでは、 header()、body()、footer()をオーバーライドすることで、それぞれの機能を実現している。

    //  example/design_pattern/template_method.cpp 8

    /// @class XxxDataFormatterXml
    /// @brief XxxDataをXmlに変換
    class XxxDataFormatterXml final : public XxxDataFormatterIF {
        // ...
    private:
        virtual std::string const& header() const noexcept final { return header_; }
        virtual std::string const& footer() const noexcept final { return footer_; }
        virtual std::string        body(XxxData const& xxx_data) const override
        {
            auto content = std::string{"<Item>\n"};

            content += "    <XxxData a=\"" + std::to_string(xxx_data.a) + "\">\n";
            content += "    <XxxData b=\"" + std::to_string(xxx_data.b) + "\">\n";
            content += "    <XxxData c=\"" + std::to_string(xxx_data.c) + "\">\n";

            return content + "</Itemp>\n";
        }

        static inline std::string const header_{"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<XxxDataFormatterXml>\n"};
        static inline std::string const footer_{"</XxxDataFormatterXml>\n"};
    };

    /// @class XxxDataFormatterCsv
    /// @brief XxxDataをCsvに変換
    class XxxDataFormatterCsv final : public XxxDataFormatterIF {
        // ...
    private:
        virtual std::string const& header() const noexcept final { return header_; }
        virtual std::string const& footer() const noexcept final { return footer_; }
        virtual std::string        body(XxxData const& xxx_data) const override
        {
            return std::string{std::to_string(xxx_data.a) + ", " + std::to_string(xxx_data.b) + ", "
                               + std::to_string(xxx_data.b) + "\n"};
        }

        static inline std::string const header_{"a, b, c\n"};
        static inline std::string const footer_{};
    };

    /// @class XxxDataFormatterTable
    /// @brief XxxDataをTableに変換
    class XxxDataFormatterTable final : public XxxDataFormatterIF {
        // ...
    private:
        virtual std::string const& header() const noexcept final { return header_; }
        virtual std::string const& footer() const noexcept final { return footer_; }
        virtual std::string        body(XxxData const& xxx_data) const override
        {
            auto a = std::string{std::string{"| "} + std::to_string(xxx_data.a)};
            auto b = std::string{std::string{"| "} + std::to_string(xxx_data.b)};
            auto c = std::string{std::string{"| "} + std::to_string(xxx_data.c)};

            a += std::string(colomun_ - a.size() + 1, ' ');
            b += std::string(colomun_ - b.size() + 1, ' ');
            c += std::string(colomun_ - c.size() + 1, ' ');

            return a + b + c + "|\n" + border_;
        }
        // ...
    };

以下の単体テストで、これらのクラスの振る舞いを示す。

    //  example/design_pattern/template_method_ut.cpp 6

    TEST(TemplateMethod, xml)
    {
        auto xml = XxxDataFormatterXml{};

        {
            auto const xd     = XxxData{1, 100, 10};
            auto const expect = std::string_view{
                "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
                "<XxxDataFormatterXml>\n"
                "<Item>\n"
                "    <XxxData a=\"1\">\n"
                "    <XxxData b=\"100\">\n"
                "    <XxxData c=\"10\">\n"
                "</Itemp>\n"
                "</XxxDataFormatterXml>\n"};
            auto const actual = xml.ToString(xd);

            ASSERT_EQ(expect, actual);
        }
        {
            auto const xds    = std::vector<XxxData>{{1, 100, 10}, {2, 200, 20}};
            auto const expect = std::string_view{
                "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
                "<XxxDataFormatterXml>\n"
                "<Item>\n"
                "    <XxxData a=\"1\">\n"
                "    <XxxData b=\"100\">\n"
                "    <XxxData c=\"10\">\n"
                "</Itemp>\n"
                "<Item>\n"
                "    <XxxData a=\"2\">\n"
                "    <XxxData b=\"200\">\n"
                "    <XxxData c=\"20\">\n"
                "</Itemp>\n"
                "</XxxDataFormatterXml>\n"};
            auto const actual = xml.ToString(xds);

            ASSERT_EQ(expect, actual);
        }
    }

    TEST(TemplateMethod, csv)
    {
        auto csv = XxxDataFormatterCsv{};

        {
            auto const xd     = XxxData{1, 100, 10};
            auto const expect = std::string_view{
                "a, b, c\n"
                "1, 100, 100\n"};
            auto const actual = csv.ToString(xd);

            ASSERT_EQ(expect, actual);
        }
        {
            auto const xds    = std::vector<XxxData>{{1, 100, 10}, {2, 200, 20}};
            auto const expect = std::string_view{
                "a, b, c\n"
                "1, 100, 100\n"
                "2, 200, 200\n"};
            auto const actual = csv.ToString(xds);

            ASSERT_EQ(expect, actual);
        }
    }

    TEST(TemplateMethod, table)
    {
        auto table = XxxDataFormatterTable{};

        // ...
    }

上記で示した実装例は、public継承による動的ポリモーフィズムを使用したため、 XxxDataFormatterXml、XxxDataFormatterCsv、XxxDataFormatterTableのインスタンスやそのポインタは、 XxxDataFormatterIFのリファレンスやポインタとして表現できる。 この性質は、FactoryNamed Constructorの実装には不可欠であるが、 逆にこのようなポリモーフィズムが不要な場合、このよう柔軟性も不要である。

そういった場合、private継承を用いるか、 テンプレートを用いた静的ポリモーフィズムを用いることでこの柔軟性を排除できる。

下記のコードはそのような実装例である。

    //  example/design_pattern/template_method_ut.cpp 112

    #if __cplusplus >= 202002L // c++20
    template <typename T>
    concept DataFormattable = requires(T t, const XxxData& xxx_data) {
        { t.Header() } -> std::convertible_to<std::string>;
        { t.Body(xxx_data) } -> std::convertible_to<std::string>;
        { t.Footer() } -> std::convertible_to<std::string>;
    };
    template <DataFormattable T>  // TはDataFormattableに制約される

    #else // c++17
    template <typename T>  // Tは下記のXxxDataFormatterXmlのようなクラス
    #endif
    class XxxDataFormatter : private T {
    public:
        std::string ToString(XxxData const& xxx_data) const { return T::Header() + T::Body(xxx_data) + T::Footer(); }

        std::string ToString(std::vector<XxxData> const& xxx_datas) const
        {
            auto ret = std::string{T::Header()};

            for (auto const& xxx_data : xxx_datas) {
                ret += T::Body(xxx_data);
            }

            return ret + T::Footer();
        }
    };

    class XxxDataFormatterXml_Impl {
    public:
        std::string const& Header() const noexcept { return header_; }
        std::string const& Footer() const noexcept { return footer_; }
        std::string        Body(XxxData const& xxx_data) const
        {
            auto content = std::string{"<Item>\n"};

            content += "    <XxxData a=\"" + std::to_string(xxx_data.a) + "\">\n";
            content += "    <XxxData b=\"" + std::to_string(xxx_data.b) + "\">\n";
            content += "    <XxxData c=\"" + std::to_string(xxx_data.c) + "\">\n";

            return content + "</Itemp>\n";
        }

    private:
        inline static std::string const header_{"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<XxxDataFormatterXml>\n"};
        inline static std::string const footer_{"</XxxDataFormatterXml>\n"};
    };

    using XxxDataFormatterXml = XxxDataFormatter<XxxDataFormatterXml_Impl>;

上記の単体テストは下記のようになる。

    //  example/design_pattern/template_method_ut.cpp 168

        auto xml = XxxDataFormatterXml{};

        {
            auto const xd     = XxxData{1, 100, 10};
            auto const expect = std::string{
                "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
                "<XxxDataFormatterXml>\n"
                "<Item>\n"
                "    <XxxData a=\"1\">\n"
                "    <XxxData b=\"100\">\n"
                "    <XxxData c=\"10\">\n"
                "</Itemp>\n"
                "</XxxDataFormatterXml>\n"};
            auto const actual = xml.ToString(xd);

            ASSERT_EQ(expect, actual);
        }
        {
            auto const xds    = std::vector<XxxData>{{1, 100, 10}, {2, 200, 20}};
            auto const expect = std::string{
                "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
                "<XxxDataFormatterXml>\n"
                "<Item>\n"
                "    <XxxData a=\"1\">\n"
                "    <XxxData b=\"100\">\n"
                "    <XxxData c=\"10\">\n"
                "</Itemp>\n"
                "<Item>\n"
                "    <XxxData a=\"2\">\n"
                "    <XxxData b=\"200\">\n"
                "    <XxxData c=\"20\">\n"
                "</Itemp>\n"
                "</XxxDataFormatterXml>\n"};
            auto const actual = xml.ToString(xds);

            ASSERT_EQ(expect, actual);
        }

Factory

Factoryは、専用関数(Factory関数)にオブジェクト生成をさせるためのパターンである。 オブジェクトを生成するクラスや関数をそのオブジェクトの生成方法に依存させたくない場合や、 オブジェクトの生成に統一されたルールを適用したい場合等に用いられる。 DI(「DI(dependency injection)」参照)と組み合わせて使われることが多い。

Templateメソッド」の例にFactoryを適用したソースコードを下記する。

下記のXxxDataFormatterFactory関数により、

といった効果がある。

    //  example/design_pattern/template_method.h 65

    enum class XxxDataFormatterMethod {
        Xml,
        Csv,
        Table,
    };

    /// @brief std::unique_ptrで保持されたXxxDataFormatterIFオブジェクトを生成するFactory関数
    /// @param method XxxDataFormatterMethodのいずれか
    /// @return std::unique_ptr<const XxxDataFormatterIF>
    ///         XxxDataFormatterIFはconstメンバ関数のみを持つため、戻り値もconstオブジェクト
    std::unique_ptr<XxxDataFormatterIF const> XxxDataFormatterFactory(XxxDataFormatterMethod method);
    //  example/design_pattern/template_method.cpp 108

    std::unique_ptr<XxxDataFormatterIF const> XxxDataFormatterFactory(XxxDataFormatterMethod method)
    {
        switch (method) {
        case XxxDataFormatterMethod::Xml:
            return std::unique_ptr<XxxDataFormatterIF const>{new XxxDataFormatterXml};  // C++11
        case XxxDataFormatterMethod::Csv:
            return std::make_unique<XxxDataFormatterCsv const>();  // C++14 make_uniqueもFactory
        case XxxDataFormatterMethod::Table:
            return std::make_unique<XxxDataFormatterTable const>();
        default:
            assert(false);
            return {};
        }
    }

以下に上記クラスの単体テストを示す。

    //  example/design_pattern/template_method_factory_ut.cpp 7

    TEST(Factory, xml)
    {
        auto xml = XxxDataFormatterFactory(XxxDataFormatterMethod::Xml);

        // ...
    }

    TEST(Factory, csv)
    {
        auto csv = XxxDataFormatterFactory(XxxDataFormatterMethod::Csv);

        // ...
    }

    TEST(Factory, table)
    {
        auto table = XxxDataFormatterFactory(XxxDataFormatterMethod::Table);

        {
            auto const xd     = XxxData{1, 100, 10};
            auto const expect = std::string_view{
                "+--------|--------|--------+\n"
                "| a      | b      | c      |\n"
                "+--------|--------|--------+\n"
                "| 1      | 100    | 10     |\n"
                "+--------|--------|--------+\n"};
            auto const actual = table->ToString(xd);

            ASSERT_EQ(expect, actual);
        }
        {
            auto const xds    = std::vector<XxxData>{{1, 100, 10}, {2, 200, 20}};
            auto const expect = std::string_view{
                "+--------|--------|--------+\n"
                "| a      | b      | c      |\n"
                "+--------|--------|--------+\n"
                "| 1      | 100    | 10     |\n"
                "+--------|--------|--------+\n"
                "| 2      | 200    | 20     |\n"
                "+--------|--------|--------+\n"};
            auto const actual = table->ToString(xds);

            ASSERT_EQ(expect, actual);
        }
    }

一般にFactory関数はヒープを使用してオブジェクトを生成する場合が多いため、 それを例示する目的でXxxDataFormatterFactoryもヒープを使用している。

この例ではその必要はないため、ヒープを使用しないFactory関数の例を下記する。

    //  example/design_pattern/template_method.cpp 125

    XxxDataFormatterIF const& XxxDataFormatterFactory2(XxxDataFormatterMethod method) noexcept
    {
        static auto xml   = XxxDataFormatterXml{};
        static auto csv   = XxxDataFormatterCsv{};
        static auto table = XxxDataFormatterTable{};

        switch (method) {
        case XxxDataFormatterMethod::Xml:
            return xml;
        case XxxDataFormatterMethod::Csv:
            return csv;
        case XxxDataFormatterMethod::Table:
            return table;
        default:
            assert(false);
            return xml;
        }
    }

次に示すのは、このパターンを使用して、プリプロセッサ命令を排除するリファクタリングの例である。

まずは、出荷仕分け向けのプリプロセッサ命令をロジックの内部に記述している問題のあるコードを示す。 このようなオールドスタイルなコードは様々な開発阻害要因になるため、避けるべきである。

    // in shipping.h

    #define SHIP_TO_JAPAN 1
    #define SHIP_TO_US 2
    #define SHIP_TO_EU 3

    class ShippingOp {
    public:
        virtual int32_t DoSomething() = 0;
        virtual ~ShippingOp()         = default;
    };
    // in shipping_japan.h

    class ShippingOp_Japan : public ShippingOp {
    public:
        ShippingOp_Japan();
        int32_t DoSomething() override;
        ~ShippingOp_Japan() override;

    private:
        // 何らかの宣言
    };
    // in xxx.cpp 仕分けに依存した処理

    // SHIPPINGはmake等のビルドツールから渡される

    #if SHIPPING == SHIP_TO_JAPAN
        auto shipping = ShippingOp_Japan{};
    #elif SHIPPING == SHIP_TO_US
        auto shipping = ShippingOp_US{};
    #elif SHIPPING == SHIP_TO_EU
        auto shipping = ShippingOp_EU{};
    #else
    #error "SHIPPING must be defined"
    #endif

        shipping.DoSomething();

このコードは、 関数テンプレートの特殊化を利用したFactoryを以下のように定義することで改善することができる。

    // in shipping.h

    // ShippingOpクラスは改善前のコードと同じ

    enum class ShippingRegion { Japan, US, EU };

    template <ShippingRegion>
    std::unique_ptr<ShippingOp> ShippingOpFactory();  // ShippingOpFactory特殊化のための宣言

    template <>
    std::unique_ptr<ShippingOp> ShippingOpFactory<ShippingRegion::Japan>();  // 特殊化関数の宣言

    template <>
    std::unique_ptr<ShippingOp> ShippingOpFactory<ShippingRegion::US>();  // 特殊化関数の宣言

    template <>
    std::unique_ptr<ShippingOp> ShippingOpFactory<ShippingRegion::EU>();  // 特殊化関数の宣言
    // in shipping_japan.cpp
    // ファクトリーの効果で、ShippingOp_Japanは外部への公開が不要

    class ShippingOp_Japan : public ShippingOp {
    public:
        ShippingOp_Japan();
        int32_t DoSomething() override;
        ~ShippingOp_Japan() override;

    private:
        // 何らかの宣言
    };

    template <>
    std::unique_ptr<ShippingOp> ShippingOpFactory<ShippingRegion::Japan>()
    {
        return std::unique_ptr<ShippingOp>{new ShippingOp_Japan};
    }
    // in xxx.cpp 仕分けに依存した処理

    // SHIPPINGはmake等のビルドツールからShippingRegionのいづれかとして渡される
    auto shipping = ShippingOpFactory<SHIPPING>();

    shipping->DoSomething();

もしくは、 関数オーバーロードを利用したFactoryを以下のように定義することで改善することもできる。

    // in shipping.h

    // ShippingOpクラスは改善前のコードと同じ

    enum class ShippingRegion { Japan, US, EU };

    template <ShippingRegion R>
    class ShippingRegion2Type : std::integral_constant<ShippingRegion, R> {
    };

    using ShippingRegionType_Japan = ShippingRegion2Type<ShippingRegion::Japan>;
    using ShippingRegionType_US    = ShippingRegion2Type<ShippingRegion::US>;
    using ShippingRegionType_EU    = ShippingRegion2Type<ShippingRegion::EU>;

    std::unique_ptr<ShippingOp> ShippingOpFactory(ShippingRegionType_Japan);
    std::unique_ptr<ShippingOp> ShippingOpFactory(ShippingRegionType_US);
    std::unique_ptr<ShippingOp> ShippingOpFactory(ShippingRegionType_EU);
    // in shipping_japan.cpp
    // ファクトリーの効果で、ShippingOp_Japanは外部への公開が不要

    class ShippingOp_Japan : public ShippingOp {
    public:
        ShippingOp_Japan();
        int32_t DoSomething() override;
        ~ShippingOp_Japan() override;

    private:
        // 何らかの宣言
    };

    std::unique_ptr<ShippingOp> ShippingOpFactory(ShippingRegionType_Japan)
    {
        return std::unique_ptr<ShippingOp>{new ShippingOp_Japan};
    }
    // in xxx.cpp 仕分けに依存した処理

    // SHIPPINGはmake等のビルドツールからShippingRegionのいづれかとして渡される
    auto shipping = ShippingOpFactory(ShippingRegion2Type<SHIPPING>{});

    shipping->DoSomething();

Named Constructor

Named Connstructorは、Singletonのようなオブジェクトを複数、生成するためのパターンである。

    //  example/design_pattern/enum_operator.h 76

    class Mammals : public Animal {  // 哺乳類
    public:
        static Mammals& Human() noexcept
        {
            static auto inst = Mammals{PhisicalAbility::Run | PhisicalAbility::Swim};
            return inst;
        }

        static Mammals& Bat() noexcept
        {
            static auto inst = Mammals{PhisicalAbility::Run | PhisicalAbility::Fly};
            return inst;
        }

        static Mammals& Whale() noexcept
        {
            static auto inst = Mammals{PhisicalAbility::Swim};
            return inst;
        }

        bool Act();

    private:
        Mammals(PhisicalAbility pa) noexcept : Animal{pa} {}
    };

上記例のHuman()、Bat()、Whale()は、人、コウモリ、クジラに対応するクラスMammalsオブジェクトを返す。

次に示したのは「Factory」の例にこのパターンを適応したコードである。

    //  example/design_pattern/template_method.h 15

    /// @brief data_storer_if.cppに定義すべきだが、サンプルであるため便宜上同じファイルで定義する
    ///        データフォーマットを行うクラスのインターフェースクラス
    class XxxDataFormatterIF {
    public:
        explicit XxxDataFormatterIF(std::string_view formatter_name) noexcept : formatter_name_{formatter_name} {}
        virtual ~XxxDataFormatterIF() = default;

        static XxxDataFormatterIF const& Xml() noexcept;
        static XxxDataFormatterIF const& Csv() noexcept;
        static XxxDataFormatterIF const& Table() noexcept;

        // ...
    };
    //  example/design_pattern/template_method.cpp 146

    XxxDataFormatterIF const& XxxDataFormatterIF::Xml() noexcept
    {
        static auto xml = XxxDataFormatterXml{};

        return xml;
    }

    XxxDataFormatterIF const& XxxDataFormatterIF::Csv() noexcept
    {
        static auto csv = XxxDataFormatterCsv{};

        return csv;
    }

    XxxDataFormatterIF const& XxxDataFormatterIF::Table() noexcept
    {
        static auto table = XxxDataFormatterTable{};

        return table;
    }

これまでにXxxDataFormatterIFオブジェクトを取得するパターンを以下のように3つ示した。

  1. Factory関数によってstd::unique_ptr<XxxDataFormatterIF>オブジェクトを返す。
  2. Factory関数によってstaticなXxxDataFormatterIFオブジェクトを返す。
  3. Named ConstructorによってstaticなXxxDataFormatterIFオブジェクトを返す。

最も汎用的な方法はパターン1であるが、 上記例のようにオブジェクトが状態を持たない場合、これは過剰な方法であり、 パターン3が最適であるように思える。このような考察からわかるように、 (単にnewする場合も含めて)オブジェクトの取得にどのような方法を用いるかは、 クラスの性質に依存する。

Proxy

Proxyとは代理人という意味で、 本物のクラスに代わり代理クラス(Proxy)が処理を受け取る (実際は、処理自体は本物クラスに委譲されることもある)パターンである。

以下の順番で例を示すことで、Proxyパターンの説明を行う。

  1. 内部構造を外部公開しているサーバ クラス
  2. そのサーバをラッピングして、使いやすくしたサーバ クラス(Facadeパターン)
  3. サーバをラップしたクラスのProxyクラス

まずは、内部構造を外部公開しているの醜悪なサーバの実装例である。

    //  example/design_pattern/bare_server.h 5

    enum class Cmd {
        SayHello,
        SayGoodbye,
        Shutdown,
    };

    struct Packet {
        Cmd cmd;
    };

    class BareServer final {
    public:
        BareServer() noexcept;
        ~BareServer();
        int GetPipeW() const noexcept  // クライアントのwrite用
        {
            return to_server_[1];
        }

        int GetPipeR() const noexcept  // クライアントのread用
        {
            return to_client_[0];
        }

        void Start();
        void Wait() noexcept;

    private:
        int         to_server_[2];  // サーバへの通信用
        int         to_client_[2];  // クライアントへの通信用
        std::thread thread_;
    };
    //  example/design_pattern/bare_server.cpp 9

    namespace {
    bool cmd_dispatch(int wfd, Cmd cmd) noexcept
    {
        static char const hello[]   = "Hello";
        static char const goodbye[] = "Goodbye";

        switch (cmd) {
        case Cmd::SayHello:
            write(wfd, hello, sizeof(hello));
            break;
        case Cmd::SayGoodbye:
            write(wfd, goodbye, sizeof(goodbye));
            break;
        case Cmd::Shutdown:
        default:
            std::cout << "Shutdown" << std::endl;
            return false;
        }

        return true;
    }

    void thread_entry(int rfd, int wfd) noexcept
    {
        for (;;) {
            auto packet = Packet{};

            if (read(rfd, &packet, sizeof(packet)) < 0) {
                continue;
            }

            if (!cmd_dispatch(wfd, packet.cmd)) {
                break;
            }
        }
    }
    }  // namespace

    BareServer::BareServer() noexcept : to_server_{-1, -1}, to_client_{-1, -1}, thread_{}
    {
        auto ret = pipe(to_server_);
        assert(ret >= 0);

        ret = pipe(to_client_);
        assert(ret >= 0);
    }

    BareServer::~BareServer()
    {
        close(to_server_[0]);
        close(to_server_[1]);
        close(to_client_[0]);
        close(to_client_[1]);
    }

    void BareServer::Start()
    {
        thread_ = std::thread{thread_entry, to_server_[0], to_client_[1]};
        std::cout << "thread started !!!" << std::endl;
    }

    void BareServer::Wait() noexcept { thread_.join(); }

下記は、上記BareServerを使用するクライアントの実装例である。通信がpipe()によって行われ、 その中身がPacket{}であること等、不要な依存関係をbare_client()に強いていることがわかる。 このような構造は、機能追加、保守作業を非効率、困難にするアンチパターンである。

    //  example/design_pattern/proxy_ut.cpp 17

    /// @brief 非同期サービスを隠蔽していないBareServerを使用したときのクライアントの例
    std::vector<std::string> bare_client(BareServer& bs)
    {
        auto const wfd = bs.GetPipeW();
        auto const rfd = bs.GetPipeR();
        auto       ret = std::vector<std::string>{};

        bs.Start();

        auto packet = Packet{};
        char buffer[30];

        packet.cmd = Cmd::SayHello;
        write(wfd, &packet, sizeof(packet));

        auto read_ret = read(rfd, buffer, sizeof(buffer));
        assert(read_ret > 0);

        ret.emplace_back(buffer);

        packet.cmd = Cmd::SayGoodbye;
        write(wfd, &packet, sizeof(packet));

        read_ret = read(rfd, buffer, sizeof(buffer));
        assert(read_ret > 0);

        ret.emplace_back(buffer);

        packet.cmd = Cmd::Shutdown;
        write(wfd, &packet, sizeof(packet));

        bs.Wait();

        return ret;
    }

次に、このむき出しの構造をラッピングする例を示す(このようなラッピングをFacadeパターンと呼ぶ)。

    //  example/design_pattern/bare_server_wrapper.h 6

    enum class Cmd;  // C++11からenumは前方宣言できる。
    class BareServer;

    class BareServerWrapper final {
    public:
        BareServerWrapper();

        void        Start();
        std::string SayHello();
        std::string SayGoodbye();
        void        Shutdown() noexcept;

    private:
        void                        send_message(enum Cmd cmd) noexcept;
        std::unique_ptr<BareServer> bare_server_;
    };
    //  example/design_pattern/bare_server_wrapper.cpp 8

    BareServerWrapper::BareServerWrapper() : bare_server_{std::make_unique<BareServer>()} {}

    void BareServerWrapper::Start() { bare_server_->Start(); }

    void BareServerWrapper::send_message(enum Cmd cmd) noexcept
    {
        auto packet = Packet{cmd};

        write(bare_server_->GetPipeW(), &packet, sizeof(packet));
    }

    std::string BareServerWrapper::SayHello()
    {
        char buffer[30];

        send_message(Cmd::SayHello);
        read(bare_server_->GetPipeR(), buffer, sizeof(buffer));

        return buffer;
    }

    std::string BareServerWrapper::SayGoodbye()
    {
        char buffer[30];

        send_message(Cmd::SayGoodbye);
        read(bare_server_->GetPipeR(), buffer, sizeof(buffer));

        return buffer;
    }

    void BareServerWrapper::Shutdown() noexcept
    {
        send_message(Cmd::Shutdown);

        bare_server_->Wait();
    }

下記は、上記BareServerWrapperのクライアントの実装例である。 BareServerWrapperがむき出しの通信をラップしたことで、bare_wrapper_client()は、 bare_client()に比べてシンプルになったことがわかる。

    //  example/design_pattern/proxy_ut.cpp 56

    /// @brief BareServerを使いやすくラップしたBareServerWrapperを使用したときのクライアントの例
    std::vector<std::string> bare_wrapper_client(BareServerWrapper& bsw)
    {
        auto ret = std::vector<std::string>{};

        bsw.Start();

        ret.emplace_back(bsw.SayHello());

        ret.emplace_back(bsw.SayGoodbye());

        bsw.Shutdown();

        return ret;
    }

次の例は、BareServerとBareServerWrapperを統合し、 さらに全体をシンプルにリファクタリングしたWrappedServerである。 Packet{}やpipe等の通信の詳細がwrapped_server.cppの無名名前空間に閉じ込められ、 クラスの隠蔽性が強化されたことで、より機能追加、保守が容易になった。

    //  example/design_pattern/wrapped_server.h 5

    class WrappedServer {
    public:
        WrappedServer() noexcept;
        virtual ~WrappedServer();

        void        Start();
        std::string SayHello() { return say_hello(); }
        std::string SayGoodbye() { return say_goodbye(); }
        void        Shutdown() noexcept;

    protected:
        virtual std::string say_hello();    // 後で拡張するためにvirtual
        virtual std::string say_goodbye();  // 同上

    private:
        int         to_server_[2];
        int         to_client_[2];
        std::thread thread_;
    };
    //  example/design_pattern/wrapped_server.cpp 8

    namespace {
    enum class Cmd {
        // ...
    };

    struct Packet {
        Cmd cmd;
    };
    }  // namespace

    // 以下、bare_server_wrapper.cppのコードとほぼ同じであるため省略。

    // ...

WrappedServerの使用例を下記する。当然ながらbare_wrapper_client()とほぼ同様になる。

    //  example/design_pattern/proxy_ut.cpp 75

    /// @brief 非同期サービスを隠蔽しているWrappedServerを使用したときのクライアントの例
    std::vector<std::string> wrapped_client(WrappedServer& ws)
    {
        auto ret = std::vector<std::string>{};

        ws.Start();

        ret.emplace_back(ws.SayHello());

        ret.emplace_back(ws.SayGoodbye());

        ws.Shutdown();

        return ret;
    }

WrappedServerが提供する機能はスレッド間通信を含むため処理コストが高い。 その対策として、サーバから送られてきた文字列をキャッシュするクラス(Proxyパターン)の導入により、 そのコストを削減する例を下記する。

    //  example/design_pattern/wrapped_server_proxy.h 7

    class WrappedServerProxy final : public WrappedServer {
    public:
        WrappedServerProxy() = default;

    private:
        std::string         hello_cashe_{};
        virtual std::string say_hello() override;
        virtual std::string say_goodbye() override;
    };
    //  example/design_pattern/wrapped_server_proxy.cpp 7

    std::string WrappedServerProxy::say_hello()
    {
        if (hello_cashe_.size() == 0) {
            hello_cashe_ = WrappedServer::say_hello();  // キャッシュとし保存
        }

        return hello_cashe_;
    }

    std::string WrappedServerProxy::say_goodbye()
    {
        hello_cashe_ = std::string{};  // helloキャッシュをクリア

        return WrappedServer::say_goodbye();
    }

下記図のようにWrappedServerProxyはWrappedServerからのパブリック継承であるため、 WrappedServerのクライアントは、そのままWrappedServerProxyのクライアントとして利用できる。

なお、正確には下記のようなクラス構造をProxyパターンと呼ぶことが多いが、 ここでは単純さを優先した。

Strategy

関数f(args)の振る舞いが、

に分けられるような場合、関数fを

に分割し、下記のように、Strategyオブジェクトをgの引数として外部から渡せるようにしたパターンである (std::sort()のようなパターン)。

    g(args, Strategyオブジェクト)

Strategyオブジェクトにいろいろなバリエーションがある場合、このパターンを使うと良い。 なお、このパターンの対象はクラスになる場合もある。

「ディレクトリをリカーシブに追跡し、引数で指定された属性にマッチしたファイルの一覧を返す関数」 を開発することを要求されたとする。

まずは、拡張性のない実装例を示す。

    //  example/design_pattern/find_files_old_style.h 4

    /// @enum FindCondition
    /// find_files_recursivelyの条件
    enum class FindCondition {
        File,              ///< pathがファイル
        Dir,               ///< pathがディレクトリ
        FileNameHeadIs_f,  ///< pathがファイル且つ、そのファイル名の先頭が"f"
    };
    //  example/design_pattern/find_files_old_style.cpp 9

    /// @brief 条件にマッチしたファイルをリカーシブに探して返す
    /// @param path      リカーシブにディレクトリをたどるための起点となるパス
    /// @param condition どのようなファイルかを指定する
    /// @return 条件にマッチしたファイルをstd::vector<std::string>で返す
    std::vector<std::string> find_files_recursively(std::string const& path, FindCondition condition)
    {
        auto files = std::vector<fs::path>{};

        // recursive_directory_iteratorはファイルシステム依存するため、その依存を排除する他の処理
        std::copy(fs::recursive_directory_iterator{path}, fs::recursive_directory_iterator{}, std::back_inserter(files));

        std::sort(files.begin(), files.end());

        auto ret = std::vector<std::string>{};

        std::for_each(files.begin(), files.end(), [&](fs::path const& p) noexcept {
            auto is_match = false;

            switch (condition) {
            case FindCondition::File:
                if (fs::is_regular_file(p)) {
                    is_match = true;
                }
                break;
            case FindCondition::Dir:
                if (fs::is_directory(p)) {
                    is_match = true;
                }
                break;
                // ...
            }

            if (is_match) {
                ret.emplace_back(p.generic_string());
            }
        });

        return ret;
    }
    //  example/design_pattern/find_files_ut.cpp 29

    TEST(Strategy, old_style)
    {
        assure_test_files_exist();  // test用のファイルがあることの確認

        auto const files_actual = find_files_recursively(test_dir, FindCondition::File);
        auto const files_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir0/gile3",
            test_dir + "dir1/dir2/file4",
            test_dir + "file0",
            test_dir + "gile1"
        });
        ASSERT_EQ(files_expect, files_actual);

        auto const dirs_actual = find_files_recursively(test_dir, FindCondition::Dir);
        auto const dirs_expect = sort(std::vector{
            test_dir + "dir0",
            test_dir + "dir1",
            test_dir + "dir1/dir2"
        });
        ASSERT_EQ(dirs_expect, dirs_actual);

        auto const f_actual = find_files_recursively(test_dir, FindCondition::FileNameHeadIs_f);
        auto const f_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir1/dir2/file4",
            test_dir + "file0"
        });
        ASSERT_EQ(f_expect, f_actual);
    }

この関数は、見つかったファイルが「引数で指定された属性」にマッチするかどうかを検査する。 検査は、「引数で指定された属性」に対するswitch文によって行われる。 これにより、この関数は「引数で指定された属性」の変更に強く影響を受ける。

下記は、この関数にStrategyパターンを適用したものである。

    //  example/design_pattern/find_files_strategy.h 7

    /// @typedef find_condition
    /// @brief find_files_recursively仮引数conditionの型(関数オブジェクトの型)
    using find_condition = std::function<bool(std::filesystem::path const&)>;

    // Strategyパターン
    /// @fn std::vector<std::string> find_files_recursively(std::string const& path,
    ///                                                     find_condition     condition);
    /// @brief 条件にマッチしたファイルをリカーシブに探索して返す
    /// @param path      リカーシブにディレクトリを辿るための起点となるパス
    /// @param condition 探索するファイルの条件
    /// @return 条件にマッチしたファイルをstd::vector<std::string>で返す
    extern std::vector<std::string> find_files_recursively(std::string const& path, find_condition condition);
    //  example/design_pattern/find_files_strategy.cpp 6

    std::vector<std::string> find_files_recursively(std::string const& path, find_condition condition)
    {
        namespace fs = std::filesystem;

        auto files = std::vector<fs::path>{};

        // recursive_directory_iteratorはファイルシステム依存するため、その依存を排除する他の処理
        std::copy(fs::recursive_directory_iterator{path}, fs::recursive_directory_iterator{}, std::back_inserter(files));

        std::sort(files.begin(), files.end());

        auto ret = std::vector<std::string>{};

        std::for_each(files.cbegin(), files.cend(), [&](fs::path const& p) {
            if (condition(p)) {
                ret.emplace_back(p.generic_string());
            }
        });

        return ret;
    }
    //  example/design_pattern/find_files_ut.cpp 69

    TEST(Strategy, strategy_lamda)
    {
        namespace fs = std::filesystem;

        assure_test_files_exist();  // test用のファイルがあることの確認

        // ラムダ式で実装
        auto const files_actual
            = find_files_recursively(test_dir, [](fs::path const& p) noexcept { return fs::is_regular_file(p); });

        auto const files_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir0/gile3",
            test_dir + "dir1/dir2/file4",
            test_dir + "file0",
            test_dir + "gile1"
        });
        ASSERT_EQ(files_expect, files_actual);

        auto const dirs_actual
            = find_files_recursively(test_dir, [](fs::path const& p) noexcept { return fs::is_directory(p); });
        auto const dirs_expect = sort(std::vector{
            test_dir + "dir0",
            test_dir + "dir1",
            test_dir + "dir1/dir2"
        });
        ASSERT_EQ(dirs_expect, dirs_actual);

        auto const f_actual = find_files_recursively(
            test_dir, [](fs::path const& p) noexcept { return p.filename().generic_string()[0] == 'f'; });

        auto const f_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir1/dir2/file4",
            test_dir + "file0"
        });
        ASSERT_EQ(f_expect, f_actual);
    }

    /// @brief find_files_recursivelyの第2仮引数に渡すためのファイル属性を決める関数
    bool condition_func(std::filesystem::path const& path) { return path.filename().generic_string().at(0) == 'f'; }

    TEST(Strategy, strategy_func_pointer)
    {
        assure_test_files_exist();  // test用のファイルがあることの確認

        // FindCondition::FileNameHeadIs_fで行ったことを関数ポインタで実装。
        auto const f_actual = find_files_recursively(test_dir, condition_func);
        auto const f_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir1/dir2/file4",
            test_dir + "file0"
        });
        ASSERT_EQ(f_expect, f_actual);
    }

    /// @brief
    ///  find_files_recursivelyの第2仮引数に渡すためのファイル属性を決める関数オブジェクトクラス。
    ///  検索条件に状態が必要な場合、関数オブジェクトを使うとよい。
    class ConditionFunctor {
    public:
        ConditionFunctor()  = default;
        ~ConditionFunctor() = default;

        /// @brief 先頭が'f'のファイルを最大2つまで探す
        bool operator()(std::filesystem::path const& path)
        {
            if (path.filename().generic_string().at(0) != 'f') {
                return false;
            }

            return ++count_ < 3;
        }

    private:
        int32_t count_{0};
    };

    TEST(Strategy, strategy_func_obj)
    {
        // 条件に状態が必要な場合(この例では最大2つまでを判断するのに状態が必要)、
        // 関数ポインタより、ファンクタの方が便利。
        auto const f_actual = find_files_recursively(test_dir, ConditionFunctor{});
        auto const f_expect = sort(std::vector{
            test_dir + "dir0/file2",
            test_dir + "dir1/dir2/file4",
        });
        ASSERT_EQ(f_expect, f_actual);
    }

捜査対象のファイル属性の指定をfind_files_recursively()の外に出しため、 その属性の追加に対して「オープン・クローズドの原則(OCP)」に対応した構造となった。

なお、上記find_files_recursivelyの第2パラメータをテンプレートパラメータとすることで、

    //  example/design_pattern/find_files_strategy.h 22

    #if __cplusplus >= 202002L  // c++20
    // ファンクタがboolを返し、std::filesystem::path const&を引数に取るかを確認するコンセプト
    namespace Inner_ {
    template <typename F>
    concept find_condition = requires(F f, std::filesystem::path const& p)
    {
        { f(p) } -> std::same_as<bool>;
    };
    }  // namespace Inner_

    template <Inner_::find_condition F>
    auto find_files_recursively2(std::string const& path, F condition)
        -> std::enable_if_t<std::is_invocable_r_v<bool, F, std::filesystem::path const&>, std::vector<std::string>>

    #else  // c++17
    template <typename F>  // Fはファンクタ
    auto find_files_recursively2(std::string const& path, F&& condition) -> std::vector<std::string>
    #endif
    {
        namespace fs = std::filesystem;

        auto files = std::vector<fs::path>{};

        // recursive_directory_iteratorでディレクトリ内のファイルを再帰的に取得
        std::copy(fs::recursive_directory_iterator{path}, fs::recursive_directory_iterator{}, std::back_inserter(files));

        std::sort(files.begin(), files.end());  // ファイルリストをソート

        auto ret = std::vector<std::string>{};

        std::for_each(files.cbegin(), files.cend(), [&](fs::path const& p) {
            if (condition(p)) {  // 条件を満たすファイルをretに追加
                ret.emplace_back(p.generic_string());
            }
        });

        return ret;
    }

のように書くこともできる。

次に示すのは、このパターンを使用して、プリプロセッサ命令を排除するリファクタリングの例である。

まずは、出荷仕分け向けのプリプロセッサ命令をロジックの内部に記述している問題のあるコードを示す。 このようなオールドスタイルなコードは様々な開発阻害要因になるため、避けるべきである。

    //  example/design_pattern/strategy_shipping_ut.cpp 11

    class X {
    public:
        X() = default;

        int32_t DoSomething()
        {
            int32_t ret{0};

    #if SHIPPING == SHIP_TO_JAPAN
            // 日本向けの何らかの処理
    #elif SHIPPING == SHIP_TO_US
            // US向けの何らかの処理
    #elif SHIPPING == SHIP_TO_JAPAN
            // EU向けの何らかの処理
    #else
    #error "SHIPPING must be defined"
    #endif
            return ret;
        }

    private:
        // 何らかの宣言
    };
    //  example/design_pattern/strategy_shipping_ut.cpp 43

    X x;

    x.DoSomething();

このコードは、Strategyを使用し以下のようにすることで、改善することができる。

    //  example/design_pattern/strategy_shipping_ut.cpp 56

    class ShippingOp {
    public:
        virtual int32_t DoSomething() = 0;
        virtual ~ShippingOp()         = default;
    };

    class X {
    public:
        X() = default;

        int32_t DoSomething(ShippingOp& shipping)
        {
            int32_t ret = shipping.DoSomething();

            // 何らかの処理

            return ret;
        }

    private:
        // 何らかの宣言
    };
    //  example/design_pattern/strategy_shipping_ut.cpp 81

    class ShippingOp_Japan : public ShippingOp {
    public:
        ShippingOp_Japan();
        int32_t DoSomething() override;
        ~ShippingOp_Japan() override;

    private:
        // 何らかの宣言
    };
    //  example/design_pattern/strategy_shipping_ut.cpp 100

    X                x;
    ShippingOp_Japan sj;

    x.DoSomething(sj);

あるいは、DI(dependency injection)と組み合わせて、下記のような改善も有用である。

    //  example/design_pattern/strategy_shipping_ut.cpp 112

    class ShippingOp {
    public:
        virtual int32_t DoSomething() = 0;
        virtual ~ShippingOp()         = default;
    };

    class X {
    public:
        explicit X(std::unique_ptr<ShippingOp> shipping) : shipping_{std::move(shipping)} {}

        int32_t DoSomething()
        {
            int32_t ret = shipping_->DoSomething();

            // 何らかの処理

            return ret;
        }

    private:
        std::unique_ptr<ShippingOp> shipping_;
        // 何らかの宣言
    };
    //  example/design_pattern/strategy_shipping_ut.cpp 138

    class ShippingOp_Japan : public ShippingOp {
    public:
        ShippingOp_Japan();
        int32_t DoSomething() override;
        ~ShippingOp_Japan() override;

    private:
        // 何らかの宣言
    };
    //  example/design_pattern/strategy_shipping_ut.cpp 157

    X x{std::unique_ptr<ShippingOp>(new ShippingOp_Japan)};

    x.DoSomething();

Visitor

このパターンは、クラス構造とそれに関連するアルゴリズムを分離するためのものである。

最初に 「クラス構造とそれに関連するアルゴリズムは分離できているが、 それ以前にオブジェクト指向の原則に反している」 例を示す。

    //  example/design_pattern/visitor.cpp 42

    /// @brief
    ///  ファイルシステムの構成物(ファイル、ディレクトリ等)を表すクラスの基底クラス
    class FileEntity {
    public:
        explicit FileEntity(std::string pathname) : pathname_{std::move(pathname)} {}
        virtual ~FileEntity() {}
        std::string const& Pathname() const { return pathname_; }

        // ...

    private:
        std::string const pathname_;
    };

    class File final : public FileEntity {
        // ...
    };

    class Dir final : public FileEntity {
        // ...
    };

    class OtherEntity final : public FileEntity {
        // ...
    };

    class Printer {
    public:
        static void PrintPathname1(FileEntity const& file_entity)
        {
            if (typeid(File) == typeid(file_entity)) {
                std::cout << file_entity.Pathname();
            }
            else if (typeid(Dir) == typeid(file_entity)) {
                std::cout << file_entity.Pathname() + "/";
            }
            else if (typeid(OtherEntity) == typeid(file_entity)) {
                std::cout << file_entity.Pathname() + "(o1)";
            }
            else {
                assert(false);
            }
        }

        static void PrintPathname2(FileEntity const& file_entity)
        {
            if (typeid(File) == typeid(file_entity)) {
                std::cout << file_entity.Pathname();
            }
            else if (typeid(Dir) == typeid(file_entity)) {
                std::cout << find_files(file_entity.Pathname());
            }
            else if (typeid(OtherEntity) == typeid(file_entity)) {
                std::cout << file_entity.Pathname() + "(o2)";
            }
            else {
                assert(false);
            }
        }
    };

下記クラス図からもわかる通り、ポリモーフィズムに反したこのような構造は複雑な依存関係を作り出す。 このアンチパターンにより同型の条件文が2度出てきてしまうため、 Printerのアルゴリズム関数が増えれば、この繰り返しはそれに比例して増える。 またFileEntityの派生が増えれば、それら条件文はすべて影響を受ける。 このようなソースコードは、このようにして等比級数的に複雑化する。

これをポリモーフィズムの導入で解決した例を示す。

    //  example/design_pattern/visitor.cpp 142

    class FileEntity {
    public:
        explicit FileEntity(std::string pathname) : pathname_{std::move(pathname)} {}
        // ...
        virtual void PrintPathname1() const = 0;
        virtual void PrintPathname2() const = 0;

    private:
        std::string const pathname_;
    };

    class File final : public FileEntity {
    public:
        // ...
        virtual void PrintPathname1() const override { std::cout << Pathname(); }
        virtual void PrintPathname2() const override { std::cout << Pathname(); }
    };

    class Dir final : public FileEntity {
    public:
        // ...
        virtual void PrintPathname1() const override { std::cout << Pathname() + "/"; }
        virtual void PrintPathname2() const override { std::cout << find_files(Pathname()); }
    };

    class OtherEntity final : public FileEntity {
    public:
        // ...
        virtual void PrintPathname1() const override { std::cout << Pathname() + "(o1)"; }
        virtual void PrintPathname2() const override { std::cout << Pathname() + "(o2)"; }
    };

    class Printer {
    public:
        static void PrintPathname1(FileEntity const& file_entity) { file_entity.PrintPathname1(); }
        static void PrintPathname2(FileEntity const& file_entity) { file_entity.PrintPathname2(); }
    };

上記例では、PrinterのアルゴリズムをFileEntityの各派生クラスのメンバ関数で実装することで、 Printerの各関数は単純化された。

これはポリモーフィズムによるリファクタリングの良い例と言えるが、 SRP(「単一責任の原則(SRP)」)に反するため、 Printerの関数が増えるたびにPrintPathname1、 PrintPathname2のようなFileEntityのインターフェースが増えてしまう。

このようなインターフェースの肥大化に対処するパターンがVisitorである。

上記例にVisitorを適用してリファクタリングした例を示す。

    //  example/design_pattern/visitor.h 9

    class FileEntityVisitor {
    public:
        virtual void Visit(File const&)        = 0;
        virtual void Visit(Dir const&)         = 0;
        virtual void Visit(OtherEntity const&) = 0;
        // ...
    };

    class FileEntity {
    public:
        explicit FileEntity(std::string pathname) : pathname_{std::move(pathname)} {}
        // ...
        std::string const& Pathname() const { return pathname_; }

        virtual void Accept(FileEntityVisitor&) const = 0;  // Acceptの仕様は安定しているので
                                                            // NVIは使わない。
    private:
        std::string const pathname_;
    };

    class File final : public FileEntity {
    public:
        using FileEntity::FileEntity;
        virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*this); }
    };

    class Dir final : public FileEntity {
    public:
        using FileEntity::FileEntity;
        virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*this); }
    };

    class OtherEntity final : public FileEntity {
    public:
        using FileEntity::FileEntity;
        virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*this); }
    };

    class PathnamePrinter1 final : public FileEntityVisitor {
    public:
        virtual void Visit(File const&) override;
        virtual void Visit(Dir const&) override;
        virtual void Visit(OtherEntity const&) override;
    };

    class PathnamePrinter2 final : public FileEntityVisitor {
    public:
        virtual void Visit(File const&) override;
        virtual void Visit(Dir const&) override;
        virtual void Visit(OtherEntity const&) override;
    };
    //  example/design_pattern/visitor.cpp 218

    void PathnamePrinter1::Visit(File const& file) { std::cout << file.Pathname(); }
    void PathnamePrinter1::Visit(Dir const& dir) { std::cout << dir.Pathname() + "/"; }
    void PathnamePrinter1::Visit(OtherEntity const& other) { std::cout << other.Pathname() + "(o1)"; }

    void PathnamePrinter2::Visit(File const& file) { std::cout << file.Pathname(); }
    void PathnamePrinter2::Visit(Dir const& dir) { std::cout << find_files(dir.Pathname()); }
    void PathnamePrinter2::Visit(OtherEntity const& other) { std::cout << other.Pathname() + "(o2)"; }

    class Printer {
    public:
        static void PrintPathname1(FileEntity const& file_entity)
        {
            auto visitor = PathnamePrinter1{};

            file_entity.Accept(visitor);
        }

        static void PrintPathname2(FileEntity const& file_entity)
        {
            auto visitor = PathnamePrinter2{};

            file_entity.Accept(visitor);
        }
    };

上記クラスの関係は下記のようになる。

このリファクタリングには、

という利点がある。 一方で、この程度の複雑さの(単純な)例では、Visitorの適用によって以前よりも構造が複雑になり、 改悪してしまった可能性があるため、デザインパターンを使用する場合には注意が必要である。

なお、上記の抜粋である下記コード

    //  example/design_pattern/visitor.h 39

    virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*this); }

はコードクローンだが、thisの型が違うため、 各Acceptが呼び出すFileEntityVisitor::Visit()も異り、単純に統一することはできない。 これを改めるためには、「CRTP(curiously recurring template pattern)」が必要になる。

次に示すソースコードはVisitorとは関係がないが、 FileEntityVisitorから派生するクラスを下記クラス図が示すように改善することで、 単体テストが容易になる例である(「DI(dependency injection)」参照)。

    //  example/design_pattern/visitor.h 72

    class TestablePrinter : public FileEntityVisitor {
    public:
        explicit TestablePrinter(std::ostream& os) : ostream_{os} {}

    protected:
        std::ostream& ostream_;
    };

    class TestablePathnamePrinter1 final : public TestablePrinter {
    public:
        explicit TestablePathnamePrinter1(std::ostream& os) : TestablePrinter{os} {}
        virtual void Visit(File const& file) override;
        virtual void Visit(Dir const& dir) override;
        virtual void Visit(OtherEntity const& other) override;
    };

    class TestablePathnamePrinter2 final : public TestablePrinter {
    public:
        explicit TestablePathnamePrinter2(std::ostream& os) : TestablePrinter{os} {}
        virtual void Visit(File const& file) override;
        virtual void Visit(Dir const& dir) override;
        virtual void Visit(OtherEntity const& other) override;
    };
    //  example/design_pattern/visitor.cpp 245

    void TestablePathnamePrinter1::Visit(File const& file) { ostream_ << file.Pathname(); }
    void TestablePathnamePrinter1::Visit(Dir const& dir) { ostream_ << dir.Pathname() + "/"; }
    void TestablePathnamePrinter1::Visit(OtherEntity const& other) { ostream_ << other.Pathname() + "(o1)"; }

    void TestablePathnamePrinter2::Visit(File const& file) { ostream_ << file.Pathname(); }

    void TestablePathnamePrinter2::Visit(Dir const& dir) { ostream_ << find_files(dir.Pathname()); }

    void TestablePathnamePrinter2::Visit(OtherEntity const& other) { ostream_ << other.Pathname() + "(o2)"; }
    //  example/design_pattern/visitor_ut.cpp 28

    TEST(Visitor, testable_visitor)
    {
        auto oss = std::ostringstream{};

        // 出力をキャプチャするため、std::coutに代えてossを使う
        auto visitor1 = TestablePathnamePrinter1{oss};
        auto visitor2 = TestablePathnamePrinter2{oss};

        auto file = File{"visitor.cpp"};
        {
            file.Accept(visitor1);
            ASSERT_EQ("visitor.cpp", oss.str());
            oss = {};
        }
        {
            file.Accept(visitor2);
            ASSERT_EQ("visitor.cpp", oss.str());
            oss = {};
        }

        auto dir = Dir{"find_files_ut_dir/dir0"};
        {
            dir.Accept(visitor1);
            ASSERT_EQ("find_files_ut_dir/dir0/", oss.str());
            oss = {};
        }
        {
            dir.Accept(visitor2);
            ASSERT_EQ("find_files_ut_dir/dir0/file2,find_files_ut_dir/dir0/gile3", oss.str());
            oss = {};
        }
    }

CRTP(curiously recurring template pattern)

CRTPとは、

    //  example/design_pattern/crtp_ut.cpp 8

    template <typename T>
    class Base {
        // ...
    };

    class Derived : public Base<Derived> {
        // ...
    };

のようなテンプレートによる再帰構造を用いて、静的ポリモーフィズムを実現するためのパターンである。

このパターンを用いて、「Visitor」のFileEntityの3つの派生クラスが持つコードクローン

    //  example/design_pattern/visitor.h 39

    virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*this); }

を解消した例を以下に示す。

    //  example/design_pattern/crtp.h 31

    class FileEntity {  // VisitorのFileEntityと同じ
    public:
        explicit FileEntity(std::string&& pathname) : pathname_{std::move(pathname)} {}
        virtual ~FileEntity() {}
        std::string const& Pathname() const { return pathname_; }

        virtual void Accept(FileEntityVisitor&) const = 0;  // Acceptの仕様は安定しているので
                                                            // NVIは使わない。
    private:
        std::string const pathname_;
    };

    template <typename T>
    class AcceptableFileEntity : public FileEntity {  // CRTP
    public:
        virtual void Accept(FileEntityVisitor& visitor) const override { visitor.Visit(*static_cast<T const*>(this)); }

    private:
        // T : public AcceptableFileEntity<T> { ... };
        // 以外の使い方をコンパイルエラーにする
        AcceptableFileEntity(std::string&& pathname) : FileEntity{std::move(pathname)} {}
        friend T;
    };

    class File final : public AcceptableFileEntity<File> {  // CRTPでクローンを解消
    public:
        explicit File(std::string pathname) : AcceptableFileEntity{std::move(pathname)} {}
    };

    class Dir final : public AcceptableFileEntity<Dir> {  // CRTPでクローンを解消
    public:
        explicit Dir(std::string pathname) : AcceptableFileEntity{std::move(pathname)} {}
    };

    class OtherEntity final : public AcceptableFileEntity<OtherEntity> {  // CRTPでクローンを解消
    public:
        explicit OtherEntity(std::string pathname) : AcceptableFileEntity{std::move(pathname)} {}
    };

Observer

Observerは、クラスSubjectと複数のクラスObserverN(N = 0, 1, 2 …)があり、 この関係が下記の条件を満たさなければならない場合に使用されるパターンである。

GUIアプリケーションをMVCで実装する場合のModelがSubjectであり、 ViewがObserverNである。

まずは、このパターンを使用しない実装例を示す。

    //  example/design_pattern/observer_ng.h 6

    /// @brief SubjectNGからの変更通知をUpdate()で受け取る。
    ///        Observerパターンを使用しない例。
    class ObserverNG_0 {
    public:
        ObserverNG_0() = default;

        virtual void Update(SubjectNG const& subject)  // テストのためにvirtual
        {
            // 何らかの処理
        }

        virtual ~ObserverNG_0() = default;
        // 何らかの定義、宣言
    };

    class ObserverNG_1 {
    public:
        // ...
    };

    class ObserverNG_2 {
    public:
        // ...
    };
    //  example/design_pattern/observer_ng.cpp 6

    void ObserverNG_1::Update(SubjectNG const& subject)
    {
        // ...
    }

    void ObserverNG_2::Update(SubjectNG const& subject)
    {
        // ...
    }
    //  example/design_pattern/subject_ng.h 9

    /// @class SubjectNG
    /// @brief 監視されるクラス。SetNumでの状態変更をObserverNG_Nに通知する。
    ///        Observerパターンを使用しない例。
    class SubjectNG final {
    public:
        explicit SubjectNG(ObserverNG_0& ng_0, ObserverNG_1& ng_1, ObserverNG_2& ng_2) noexcept
            : num_{0}, ng_0_{ng_0}, ng_1_{ng_1}, ng_2_{ng_2}
        {
        }

        void SetNum(uint32_t num);
        // ...
    };
    //  example/design_pattern/subject_ng.cpp 4

    void SubjectNG::SetNum(uint32_t num)
    {
        if (num_ == num) {
            return;
        }

        num_ = num;

        notify();  // subjectが変更されたことをobserverへ通知
    }

    void SubjectNG::notify()
    {
        ng_0_.Update(*this);
        ng_1_.Update(*this);
        ng_2_.Update(*this);
    }
    //  example/design_pattern/observer_ut.cpp 15

    struct ObserverNG_0_Test : ObserverNG_0 {  // テスト用クラス
        virtual void Update(SubjectNG const& subject) final
        {
            ++call_count;
            num = subject.GetNum();
        }

        uint32_t                call_count{0};
        std::optional<uint32_t> num{};
    };

    auto ng0 = ObserverNG_0_Test{};
    auto ng1 = ObserverNG_1{};
    auto ng2 = ObserverNG_2{};

    auto subject = SubjectNG{ng0, ng1, ng2};

    ASSERT_EQ(0, ng0.call_count);  // まだ何もしていない
    ASSERT_FALSE(ng0.num);

    subject.SetNum(1);
    subject.SetNum(2);

    ASSERT_EQ(2, ng0.call_count);
    ASSERT_EQ(2, *ng0.num);

    subject.SetNum(2);  // 同じ値をセットしたため、Updateは呼ばれないはず
    ASSERT_EQ(2, ng0.call_count);
    ASSERT_EQ(2, *ng0.num);

上記実装例のクラス図を下記する。 これを見ればわかるように、クラスSubjectNGとクラスObserverNG_Nは相互依存しており、機能追加、 修正が難しいだけではなく、この図の通りにパッケージを分割した場合 (パッケージがライブラリとなると前提)、リンクすら難しくなる。

このようなクラス間の依存関係は下記のようにファイル間の依存関係に反映される。 このような相互依存は、差分ビルドの長時間化等の問題も引き起こす。

次に、上記にObserverパターンを適用した実装例 (Subjectを抽象クラスにすることもあるが、下記例ではSubjectを具象クラスにしている)を示す。

    //  example/design_pattern/observer_ok.h 3

    /// @brief SubjectOKからの変更通知をUpdate()で受け取る。
    ///        Observerパターンの使用例。
    class ObserverOK_0 : public Observer {
        // ...
    private:
        virtual void update(SubjectOK const& subject) override;
    };

    class ObserverOK_1 : public Observer {
        // ...
    private:
        virtual void update(SubjectOK const& subject) override;
    };

    class ObserverOK_2 : public Observer {
        // ...
    private:
        virtual void update(SubjectOK const& subject) override;
    };
    //  example/design_pattern/observer_ok.cpp 5

    void ObserverOK_0::update(SubjectOK const& subject)
    {
        // ...
    }

    void ObserverOK_1::update(SubjectOK const& subject)
    {
        // ...
    }

    void ObserverOK_2::update(SubjectOK const& subject)
    {
        // ...
    }
    //  example/design_pattern/subject_ok.h 8

    /// @brief 監視されるクラス。SetNumでの状態変更をObserverOK_Nに通知する。
    ///        Observerパターンの使用例。
    class SubjectOK final {
    public:
        SubjectOK() : observers_{}, num_{0} {}

        void SetNum(uint32_t num)
        {
            if (num_ == num) {
                return;
            }

            num_ = num;

            notify();  // subjectが変更されたことをobserverへ通知
        }

        void     Attach(Observer& observer);           // Observerの登録
        void     Detach(Observer& observer) noexcept;  // Observerの登録解除
        uint32_t GetNum() const noexcept { return num_; }

    private:
        void notify() const;

        std::list<Observer*> observers_;
        // ...
    };

    /// @brief SubjectOKを監視するクラスの基底クラス
    class Observer {
    public:
        Observer() = default;
        void Update(SubjectOK const& subject) { update(subject); }

        // ...
    private:
        virtual void update(SubjectOK const& subject) = 0;
        // ...
    };
    //  example/design_pattern/subject_ok.cpp 3

    void SubjectOK::Attach(Observer& observer_to_attach) { observers_.push_back(&observer_to_attach); }

    void SubjectOK::Detach(Observer& observer_to_detach) noexcept
    {
        observers_.remove_if([&observer_to_detach](Observer* observer) { return &observer_to_detach == observer; });
    }

    void SubjectOK::notify() const
    {
        for (auto observer : observers_) {
            observer->Update(*this);
        }
    }
    //  example/design_pattern/observer_ut.cpp 51

    struct ObserverOK_Test : Observer {  // テスト用クラス
        virtual void update(SubjectOK const& subject) final
        {
            ++call_count;
            num = subject.GetNum();
        }

        uint32_t                call_count{0};
        std::optional<uint32_t> num{};
    };

    auto ok0 = ObserverOK_Test{};
    auto ok1 = ObserverOK_1{};
    auto ok2 = ObserverOK_2{};

    auto subject = SubjectOK{};

    subject.Attach(ok0);
    subject.Attach(ok1);
    subject.Attach(ok2);

    ASSERT_EQ(0, ok0.call_count);  // まだ何もしていない
    ASSERT_FALSE(ok0.num);

    subject.SetNum(1);
    subject.SetNum(2);

    ASSERT_EQ(2, ok0.call_count);
    ASSERT_EQ(2, *ok0.num);

    subject.SetNum(2);  // 同じ値をセットしたため、Updateは呼ばれないはず
    ASSERT_EQ(2, ok0.call_count);
    ASSERT_EQ(2, *ok0.num);

上記実装例のクラス図を下記する。 Observerパターンを使用しない例と比べると、 クラスSubjectOKとクラスObserverOK_Nとの相互依存が消えたことがわかる。

最後に、上記のファイルの依存関係を示す。 ファイル(パッケージ)の依存関係においてもSubjectOKはObserverOKに依存していないことがわかる (MVCに置き換えると、ModelはViewに依存していない状態であるといえる)。

MVC

MVCはデザインパターンと言うよりもアーキテクチャパターンである。 一般にGUIアプリケーションのアーキテクチャに使用されるが、 外部からの非同期要求を処理するアプリケーションのアーキテクチャにも相性が良い。

MVCのそれぞれのアルファベットの意味は、下記テーブルの通りである。

MVC 主な役割
M Model ビジネスロジックの処理
V View UIへの出力
C Controller 入力をModelへ送信

下記はMVCの概念モデルである(矢印は制御の流れであって、依存関係ではない)。

制御の流れは、

  1. ユーザの入力に応じてControllerのメソッドが呼び出される。
  2. Controllerのメソッドは、ユーザの入力に応じた引数とともにModelのメソッドを呼び出す。
  3. Modelは、それに対応するビジネスロジック等の処理を(通常、非同期に)行い、 自分自身の状態を変える(変わらないこともある)。
  4. Modelの状態変化は、そのModelのオブザーバーとして登録されているViewに通知される。
  5. Viewは関連するデータをModelから取得し、それを出力(UIに表示)する。

ViewはModelのObserverであるため、ModelはViewへ依存しない。 多々あるMVC派生パターンすべてで、そのような依存関係は存在しない (具体的なパターンの選択はプロジェクトで使用するGUIフレームワークに強く依存する)。

そのようにする理由は下記の通りで、極めて重要な規則である。

Cでのクラス表現

このドキュメントは、C++でのソフトウェア開発を前提としているため、 ここで示したコードもC++で書いているが、

ような目的のためにCでのクラスの実現方法を例示する。

下記のような基底クラスPointとその派生クラスPoint3Dがあった場合、

C++では、Pointのコードは下記のように表すことが一般的である。

    //  example/design_pattern/class_ut.cpp 7

    class Point {
    public:
        explicit Point(int x, int y) noexcept : x_{x}, y_{y} {}
        virtual ~Point() = default;

        void SetXY(int x, int y) noexcept
        {
            x_ = x;
            y_ = y;
        }

        void GetXY(int& x, int& y) const noexcept
        {
            x = x_;
            y = y_;
        }

        virtual int Quantity() const noexcept { return x_ * y_; }

        virtual void Multipy(int m) noexcept
        {
            x_ *= m;
            y_ *= m;
        }

    private:
        int x_;
        int y_;
    };

この単体テストは、下記のようになる。

    //  example/design_pattern/class_ut.cpp 42

    Point a{1, 2};

    int x;
    int y;
    a.GetXY(x, y);
    ASSERT_EQ(x, 1);
    ASSERT_EQ(y, 2);

    a.SetXY(3, 4);

    a.GetXY(x, y);
    ASSERT_EQ(x, 3);
    ASSERT_EQ(y, 4);

    ASSERT_EQ(a.Quantity(), 12);

    a.Multipy(2);
    ASSERT_EQ(a.Quantity(), 48);

これをCで表した場合、下記のようになる。

    //  example/design_pattern/class_ut.cpp 124

    struct Point {
        int x;
        int y;

        int (*const Quantity)(Point const* self);
        void (*const Multipy)(Point* self, int m);
    };

    static int point_quantity(Point const* self) { return self->x * self->y; }

    static void point_multipy(Point* self, int m)
    {
        self->x *= m;
        self->y *= m;
    }

    Point Point_Construct(int x, int y)
    {
        Point ret = {x, y, point_quantity, point_multipy};  // C言語のつもり

        return ret;
    }

    void Point_SetXY(Point* self, int x, int y)
    {
        self->x = x;
        self->y = y;
    }

    void Point_GetXY(Point* self, int* x, int* y)
    {
        *x = self->x;
        *y = self->y;
    }

C++のメンバ関数はプログラマから見えない引数thisを持つ。 これを表したものが各関数の第1引数selfである。 また、ポリモーフィックな関数は関数ポインタで、 非ポリモーフィックな関数は通常の関数で表される。

この単体テストは、下記のようになる。

    //  example/design_pattern/class_ut.cpp 164

    Point a = Point_Construct(1, 2);

    int x;
    int y;

    Point_GetXY(&a, &x, &y);
    ASSERT_EQ(x, 1);
    ASSERT_EQ(y, 2);

    Point_SetXY(&a, 3, 4);

    Point_GetXY(&a, &x, &y);
    ASSERT_EQ(x, 3);
    ASSERT_EQ(y, 4);

    ASSERT_EQ(a.Quantity(&a), 12);

    a.Multipy(&a, 2);
    ASSERT_EQ(a.Quantity(&a), 48);

Pointから派生したクラスPoint3DのC++での実装を以下に示す。

    //  example/design_pattern/class_ut.cpp 65

    class Point3D : public Point {
    public:
        explicit Point3D(int x, int y, int z) noexcept : Point{x, y}, z_{z} {}

        void SetXYZ(int x, int y, int z) noexcept
        {
            SetXY(x, y);
            z_ = z;
        }

        void GetXYZ(int& x, int& y, int& z) const noexcept
        {
            GetXY(x, y);
            z = z_;
        }

        virtual int Quantity() const noexcept override { return Point::Quantity() * z_; }

        virtual void Multipy(int m) noexcept override
        {
            Point::Multipy(m);
            z_ *= m;
        }

    private:
        int z_;
    };

この単体テストは、下記のようになる。

    //  example/design_pattern/class_ut.cpp 98

    auto  a = Point3D{1, 2, 3};
    auto& b = a;

    auto x = int{};
    auto y = int{};
    b.GetXY(x, y);
    ASSERT_EQ(x, 1);
    ASSERT_EQ(y, 2);

    b.SetXY(3, 4);

    b.GetXY(x, y);
    ASSERT_EQ(x, 3);
    ASSERT_EQ(y, 4);

    ASSERT_EQ(b.Quantity(), 36);

    b.Multipy(2);
    ASSERT_EQ(b.Quantity(), 288);

これをCで実装したものが下記である。

    //  example/design_pattern/class_ut.cpp 188

    struct Point3D {
        Point point;
        int   z;
    };

    static int point3d_quantity(Point const* self)
    {
        Point3D const* self_derived = (Point3D const*)self;

        return point_quantity(self) * self_derived->z;
    }

    static void point3d_multipy(Point* self, int m)
    {
        point_multipy(self, m);

        Point3D* self_derived = (Point3D*)self;

        self_derived->z *= m;
    }

    Point3D Point3D_Construct(int x, int y, int z)
    {
        Point3D ret{{x, y, point3d_quantity, point3d_multipy}, z};

        return ret;
    }

この単体テストは、下記のようになる。

    //  example/design_pattern/class_ut.cpp 221

    Point3D a = Point3D_Construct(1, 2, 3);
    Point*  b = &a.point;

    int x;
    int y;

    Point_GetXY(b, &x, &y);
    ASSERT_EQ(x, 1);
    ASSERT_EQ(y, 2);

    Point_SetXY(b, 3, 4);

    Point_GetXY(b, &x, &y);
    ASSERT_EQ(x, 3);
    ASSERT_EQ(y, 4);

    ASSERT_EQ(b->Quantity(b), 36);

    b->Multipy(b, 2);
    ASSERT_EQ(b->Quantity(b), 288);

以上からわかる通り、Cでのクラス実装はC++のものに比べ、

等といった問題があるため、「何らかの事情でC++が使えない」チームは、 なるべく早い時期にその障害を乗り越えることをお勧めする。

どうしてもその障害を超えられない場合は、 モダンC言語プログラミング が役に立つだろう。

テンプレートメタプログラミング

本章でのテンプレートメタプログラミングとは、下記の2つを指す。

C++においては、この2つはテンプレートを用いたプログラミングとなる。

ジェネリックプログラミングとは、具体的なデータ型に依存しない抽象的プログラミングであり、 その代表的な成果物はSTLのコンテナやそれらを扱うアルゴリズム関数テンプレートである。

この利点は、

の開発を行うことを考えれば明らかである。

ジェネリックプログラミングが無ければ、コンテナの種類はi x j個必要になり、 それらに適用するアルゴリズム関数は、i x j x k個必要になる。 また、サポートする型の増加に伴いコンテナやアルゴリズム関数は指数関数的に増えて行く。 C言語のqsort()のように強引なキャストを使い、この増加をある程度食い止めることはできるが、 それによりコンパイラによる型チェックは無効化され、 静的な型付け言語を使うメリットの多くを失うことになる。

メタプログラミングとは、

のような目的で行われるテンプレートプログラミングの総称である。

ジェネリックプログラミングとメタプログラミングに明確な境界はない、 また明確にしたところで大きなメリットはと思われるため、 本章では、これらをまとめた概念であるテンプレートメタプログラミングとして扱い、 ログ取得ライブラリやSTLを応用したNstdライブラリの実装を通して、 これらのテクニックや、使用上の注意点について解説する。

c++20から導入されたコンセプトによりジェネリックプログラミングは、 開発容易性、可読性、保守性が大きく向上しため、この章のコード例には、 コンセプト(concept, requires)を多用した。

が、この副作用として、 c++17までしか使えない読者の参考にならないコードが増えてしまうことを避けるため、 以下のような#ifdefを使うことによりc++17でも使えるコード例となるようにした (本来、#ifdefは使うべきではないが、#ifdefの数少ない使いどころだと判断した)。

    //  example/template/cplusplus.cpp 4

    #if __cplusplus >= 202002L  // c++20
    // c++20以上の機能を使い、c++17以下の機能ではill-formedとなるコード
    template <typename T, typename U>
    concept same_as = requires(T const* t, U const* u)
    {
        {t = u, u = t};
    };

    #else  // c++17以下の機能を使い上記のコードと同じ機能を持つ実装
    template <typename T, typename U>
    inline constexpr bool same_as = std::is_same_t<T, U>;
    #endif

この章の構成

   ログ取得ライブラリの開発
    要件
    ログ取得ライブラリのインターフェース
    パラメータパック
    Loggerの実装
    ユーザ定義型とそのoperator<<のname lookup
    Ints_tのログ登録

   Nstdライブラリの開発
    Nstdライブラリを使用したリファクタリング
    安全なvector
    安全な配列型コンテナ
    初期化子リストの副作用

   メタ関数のテクニック
    STLのtype_traits
    is_void_xxxの実装
    is_same_xxxの実装
    AreConvertibleXxxの実装
    関数の存在の診断

   Nstdライブラリの開発2
    SafeArray2の開発
    Nstd::SafeIndexの開発
    Nstd::SafeIndexのoperator<<の開発
    コンテナ用Nstd::operator<<の開発

   Nstdライブラリの開発3(浮動小数点関連)
    浮動小数点の比較
    固定小数点クラス
    固定小数点リテラル
    有理数クラス
    有理数リテラル

   ログ取得ライブラリの開発2
   その他のテンプレートテクニック
    forwardingリファレンスとstd::forward
    ジェネリックラムダによる関数内での関数テンプレートの定義
    クラステンプレートと継承の再帰構造
    意図しないname lookupの防止
    Nstd::Type2Strの開発
    静的な文字列オブジェクト
    関数型をテンプレートパラメータで使う

   注意点まとめ

このドキュメントの構成に戻る。
___

ログ取得ライブラリの開発

ここではログ取得ライブラリの開発を行う。

要件

ログ取得ライブラリの要件は、

ことのみとする。下記はその文字列を取り出した例である。

    app/src/main.cpp: 96:Options
                         cmd       : GenPkg
                         in        : 
                         out       : 
                         recursive : true
                         src_as_pkg: false
        ...

    app/src/main.cpp: 51:start GenPkg

    file_utils/ut/path_utils.cpp: 38:1
    file_utils/ut/path_utils.cpp: 48:ut_data/app1
                         ut_data/app1/mod1
                         ut_data/app1/mod2

        ...

    app/src/main.cpp:100:Exit:0

単純化のためログの番号やタイムスタンプのサポートはしない。 また、実行速度や仕様メモリ量の制限等も本章の趣旨とは離れるため考慮しない。

ログ取得ライブラリのインターフェース

ログ取得コードにより、コードクローンが増えたり、主なロジックの可読性が下がったのでは、 本末転倒であるため、下記のようにワンライナーで記述できるべきだろう。

    LOGGER("start GenPkg", objA, objB, objC);

また、要件で述べた通り、ソースコード位置を特定できなければならないため、 上記LOGGERは下記のような関数型マクロにならざるを得ない。

    #define LOGGER(...) CppLoggerFunc(__FILE__, __LINE__, __VA_ARGS__)

CppLoggerFuncをクラス外の関数として実装した場合、ログ保持のための静的なオブジェクトが必要になる。 これは避けるべきなので、「Singleton」で述べた構造を導入すると、

    #define LOGGER(...) Logger::Inst().Set(__FILE__, __LINE__, __VA_ARGS__)

のような関数型マクロとなる。これがログ取得ライブラリの主なインターフェースとなる。

C言語プログラミングばかりをやりすぎて、 視神経と手の運動神経が直結してしまった大脳レス・プログラマーは、

    __VA_ARGS__

を見るとprintf(…)のような可変長引数を取る関数を思い浮かべる。 「人は一昨日も行ったことを昨日も行ったという理由で、今日もそれを行う」 という諺を思い出すと気持ちは分からなくもないが、 C++ではprintf(…)のような危険な可変長引数を取る関数を作ってはならない。 パラメータパックを使って実装するべきである。

パラメータパック

C++11で導入されたパラメータパックはやや複雑なシンタックスを持つため、 まずは単純な例から説明する。

次のような単体テストをパスする関数テンプレートsumをパラメータパックで実装することを考える。

    //  example/template_cpp17/parameter_pack_ut.cpp 26

    ASSERT_EQ(1, sum(1));
    ASSERT_EQ(3, sum(1, 2));
    ASSERT_EQ(6, sum(1, 2, 3));
    ASSERT_FLOAT_EQ(6.0, sum(1, 2.0, 3.0));
    ASSERT_EQ(10, sum(1, 2, 3, 4));

    // ...

    ASSERT_EQ(55, sum(1, 2, 3, 4, 5, 6, 7, 8, 9, 10));

    // ...

sumの要件は、

のようなものになるため、関数テンプレートsumは下記のように書ける。

    //  example/template_cpp17/parameter_pack_ut.cpp 9

    template <typename HEAD>
    int sum(HEAD head)
    {
        return head;
    }

    template <typename HEAD, typename... TAIL>
    int sum(HEAD head, TAIL... tails)
    {
        return head + sum(tails...);
    }

1つ目の関数テンプレートsumは引数が一つの場合に対応する。 2つ目の関数テンプレートsumは引数が2つ以上の場合に対応する。

2つ目の関数テンプレートsumのテンプレートパラメータ

    typename... TAIL

がパラメータパックであり、0個以上の型が指定されることを意味する。 これを関数の引数として表すシンタックスが

    TAIL... tails

であり、同様に0個以上のインスタンスが指定されることを表している。

HEADとTAILより、2つ目のsumは1個以上の引数を取れることになるため、 引数が1つの場合、どちらのsumを呼び出すかが曖昧になるように思えるが、 ベストマッチの観点から1つ目のsumが呼び出される。

sum(1, 2, 3)の呼び出し時のsumの展開を見てみることでパラメータパックの振る舞いを解説する。

この呼び出しは、2つ目のsumにマッチする。従って下記のように展開される。

    return 1 + sum(2, 3);

sum(2, 3)も同様に展開されるため、上記コードは下記のようになる。

    return 1 + 2 + sum(3);

sum(3)は1つ目のsumにマッチするため、最終的には下記のように展開される。

    return 1 + 2 + 3;

これで基本的な要件は満たしたが、このsumでは下記のようなコードもコンパイルできてしまう。

    //  example/template_cpp17/parameter_pack_ut.cpp 43

    ASSERT_EQ(2, sum(1, true, false));

これを認めるかどうかはsumの仕様次第だが、ここではこれらを認めないようにしたい。 また、引数に浮動小数が与えられた場合でも、sumの戻り値の型がintなる仕様には問題がある。 合わせてそれも修正する。

    //  example/template_cpp17/parameter_pack_ut.cpp 53

    template <typename HEAD>
    auto sum(HEAD head)
    {
        // std::is_sameの2パラメータが同一であれば、std::is_same<>::value == true
        static_assert(!std::is_same<HEAD, bool>::value, "arguemnt type must not be bool.");

        return head;
    }

    template <typename HEAD, typename... TAIL>
    auto sum(HEAD head, TAIL... tails)
    {
        // std::is_sameの2パラメータが同一であれば、std::is_same<>::value == true
        static_assert(!std::is_same<HEAD, bool>::value, "arguemnt type must not be bool.");

        return head + sum(tails...);
    }
    //  example/template_cpp17/parameter_pack_ut.cpp 83

    // boolを除く算術型のみ認めるため、下記はコンパイルできない。
    // ASSERT_EQ(2, sum(1, true, false));

    auto i1 = sum(1);
    auto i2 = sum(1, 2);

    static_assert(std::is_same<int, decltype(i1)>::value);  // 1の型はint
    static_assert(std::is_same<int, decltype(i2)>::value);  // 1 + 2の型はint

    auto u1 = sum(1U);
    auto u2 = sum(1U, 2);

    static_assert(std::is_same<unsigned int, decltype(u1)>::value);  // 1Uの型はunsigned int
    static_assert(std::is_same<unsigned int, decltype(u2)>::value);  // 1U + 2の型はunsigned int

    auto f0 = sum(1.0, 1.2);
    static_assert(std::is_same<double, decltype(f0)>::value);

    // ただし、戻り型をautoにしたため、下記も認められるようになった。
    // これに対しての対処は別の関数で行う。
    auto str = sum(std::string{"1"}, std::string{"2"});

    ASSERT_EQ(str, "12");
    static_assert(std::is_same<std::string, decltype(str)>::value);

以上で示したようにパラメータパックにより、 C言語での可変長引数関数では不可能だった引数の型チェックができるようになったため、 C言語でのランタイムエラーがコンパイルエラーにできるようになった。

なお、上記コードで使用したstd::is_sameは、 与えられた2つのテンプレートパラメータが同じ型であった場合、 valueをtrueで初期化するクラステンプレートであり、 type_traitsで定義されている (後ほど使用するstd::is_same_vはstd::is_same<>::valueと等価な定数テンプレート)。 この実装については、後ほど説明する。

パラメータパックの畳みこみ式

上記したsumは、パラメータパックの展開に汎用的な再帰構造を用いたが、 C++17で導入された畳みこみ式を用い、以下の様に簡潔に記述することもできる。

    //  example/template_cpp17/parameter_pack_ut.cpp 123

    template <typename... ARGS>
    auto sum(ARGS... args)
    {
        return (args + ...);  // 畳みこみ式は()で囲まなければならない。
    }
    //  example/template_cpp17/parameter_pack_ut.cpp 134

    ASSERT_EQ(1, sum(1));
    ASSERT_EQ(3, sum(1, 2));
    ASSERT_EQ(6, sum(1, 2, 3));
    ASSERT_EQ(6.0, sum(1, 2.0, 3.0));
    ASSERT_EQ(10, sum(1, 2, 3, 4));
    ASSERT_EQ(55, sum(1, 2, 3, 4, 5, 6, 7, 8, 9, 10));

畳みこみ式で使用できる演算子を以下に示す。

    + - * / % ^ & | = < > << >> += -= *= /= %= ^= &= |= <<= >>= == != <= >= && || , .* ->*

これらの演算子がオーバーロードである場合でも、畳みこみ式は利用できる。

前から演算するパラメータパック

パラメータパックを使うプログラミングでは、 上記したHEADとTAILによるリカーシブコールがよく使われるパターンであるが、 これには後ろから処理されるという、微妙な問題点がある。

これまでのsumに代えて下記のようなproduct(掛け算)を考える。

    //  example/template_cpp17/parameter_pack_ut.cpp 149

    template <typename HEAD>
    auto product(HEAD head)
    {
        static_assert(!std::is_same_v<HEAD, bool>, "arguemnt type must not be bool.");
        static_assert(std::is_arithmetic_v<HEAD>, "arguemnt type must be arithmetic.");

        return head;
    }

    template <typename HEAD, typename... TAIL>
    auto product(HEAD head, TAIL... tails)
    {
        static_assert(!std::is_same_v<HEAD, bool>, "arguemnt type must not be bool.");
        static_assert(std::is_arithmetic_v<HEAD>, "arguemnt type must be arithmetic.");

        return head * product(tails...);
    }

このコードの単体テストは、

    //  example/template_cpp17/parameter_pack_ut.cpp 173

    ASSERT_EQ(1, product(100, 0.1, 0.1));

のようになるだろうが、 std::numeric_limits<>::epsilonを使用していないため (「浮動小数点型」参照) 、このテストはパスしない。一方で、以下のテストはパスする。

    //  example/template_cpp17/parameter_pack_ut.cpp 178

    ASSERT_EQ(1, product(0.1, 0.1, 100));

一般に0.01の2進数表現は無限小数になるため、これを含む演算にはepsilon以下の演算誤差が発生する。 前者単体テストでは、後ろから演算されるために処理の途中に0.01が現れるが、 後者では現れないため、この誤差の有無が結果の差になる。

このような演算順序による微妙な誤差が問題になるような関数を開発する場合、 演算は見た目の順序通りに行われた方が良いだろう。 ということで、productを前から演算するように修正する。

    //  example/template_cpp17/parameter_pack_ut.cpp 196

    template <typename HEAD>
    auto product(HEAD head)
    {
        static_assert(!std::is_same_v<HEAD, bool>, "arguemnt type must not be bool.");
        static_assert(std::is_arithmetic_v<HEAD>, "arguemnt type must be arithmetic.");

        return head;
    }

    template <typename HEAD, typename HEAD2, typename... TAIL>
    auto product(HEAD head, HEAD2 head2, TAIL... tails)
    {
        static_assert(!std::is_same_v<HEAD, bool>, "arguemnt type must not be bool.");
        static_assert(std::is_arithmetic_v<HEAD>, "arguemnt type must be arithmetic.");

        return product(head * head2, tails...);
    }

HEAD、TAILに加えHEAD2を導入することで、前からの演算を実装できる (引数が一つのproductに変更はない)。当然ながら、これにより、

    //  example/template_cpp17/parameter_pack_ut.cpp 220

    ASSERT_EQ(1, product(100, 0.1, 0.1));

はパスし、下記はパスしなくなる。

    //  example/template_cpp17/parameter_pack_ut.cpp 225

    ASSERT_EQ(1, product(0.1, 0.1, 100));

Loggerの実装

パラメータパックを使用したログ取得コードは以下のようになる。

    //  example/template/logger_0.h 48

    #define LOGGER_P(...) Logging::Logger::Inst().Set(__FILE__, __LINE__)
    #define LOGGER(...) Logging::Logger::Inst().Set(__FILE__, __LINE__, __VA_ARGS__)

予定していたものと若干違う理由は、__VA_ARGS__が1個以上の識別子を表しているからである。 従って、通過ポイントのみをロギングしたい場合、LOGGER_P()を使うことになる。 gcc拡張を使えば、LOGGER_PとLOGGERを統一できるが、そのようなことをすると別のコンパイラや、 静的解析ツールが使用できなくなることがあるため、残念だが上記のように実装するべきである。

Loggerクラスの実装は、下記のようになる。

    //  example/template/logger_0.h 6

    namespace Logging {
    class Logger {
    public:
        static Logger&       Inst();
        static Logger const& InstConst() { return Inst(); }

        std::string Get() const;  // ログデータの取得
        void        Clear();      // ログデータの消去

        template <typename... ARGS>  // ログの登録
        void Set(char const* filename, uint32_t line_no, ARGS const&... args)
        {
            oss_.width(32);
            oss_ << filename << ":";

            oss_.width(3);
            oss_ << line_no;

            set_inner(args...);
        }

        Logger(Logger const&)            = delete;
        Logger& operator=(Logger const&) = delete;

    private:
        void set_inner() { oss_ << std::endl; }

        template <Nstd::Printable HEAD, Nstd::Printable... TAIL>
        void set_inner(HEAD const& head, TAIL const&... tails)
        {
            oss_ << ":" << head;
            set_inner(tails...);
        }

        Logger() {}
        std::ostringstream oss_{};
    };
    }  // namespace Logging

すでに述べた通り、

ようにした。 また、識別子の衝突を避けるために、名前空間Loggingを導入し、Loggerはその中で宣言した。

次に、どのように動作するのかを単体テストで示す。

    //  example/template/logger_0_ut.cpp 16

    auto a = 1;
    auto b = std::string{"b"};

    LOGGER_P();               // (1)
    LOGGER(5, "hehe", a, b);  // (2)
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto exp = std::string{log_str_exp(__FILE__, line_num - 2, "\n")};  // (1)のログ
    exp += log_str_exp(__FILE__, line_num - 1, ":5:hehe:1:b\n");        // (2)のログ
    ASSERT_EQ(exp, s);

    Logging::Logger::Inst().Clear();  // クリアの確認
    ASSERT_EQ("", Logging::Logger::InstConst().Get());

行を含む出力の期待値をソースコードに直接書くと行増減のたびにそれらを修正する必要ある。 期待値の一部を自動計算する下記コード(上記コードで使用)を単体テストに導入することで、 そういった修正を避けている。

    //  example/template/logger_ut.h 4

    inline std::string line_to_str(uint32_t line)
    {
        if (line < 10) {
            return ":  ";
        }
        else if (line < 100) {
            return ": ";
        }
        else if (line < 1000) {
            return ":";
        }
        else {
            assert(false);  // 1000行を超える単体テストファイルを認めない
            return "";
        }
    }

    inline std::string log_str_exp(char const* filename_cstr, uint32_t line, char const* str)
    {
        auto const filename = std::string{filename_cstr};
        auto const len      = 32 > filename.size() ? 32 - filename.size() : 0;
        auto       ret      = std::string(len, ' ');

        ret += filename;
        ret += line_to_str(line);
        ret += std::to_string(line);
        ret += str;

        return ret;
    }

アプリケーションの開発では、 下記のようなユーザが定義した名前空間とクラスを用いることがほとんどである。

    //  example/template/app_ints.h 12

    namespace App {

    class X {
    public:
        X(std::string str, int num) : str_{std::move(str)}, num_{num} {}
        std::string ToString() const { return str_ + "/" + std::to_string(num_); }
        // ...
    };
    }  // namespace App

このApp::Xのインスタンスのログを取得できることも、当然Logging::Loggerの要件となる。 従って、下記の単体テストはコンパイルでき、且つパスすることが必要になる。

    //  example/template/logger_0_ut.cpp 42

    auto x = App::X{"name", 3};

    LOGGER(1, x);
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto exp = std::string{log_str_exp(__FILE__, line_num - 1, ":1:name/3\n")};
    ASSERT_EQ(exp, s);

Logging::Loggerのコードからオブジェクトのログを登録するためには、 Logging::Logger::set_innerがコンパイルできなければならない。 つまり、

    std::ostream& operator<<(std::ostream&, ログ登録オブジェクトの型)

の実装が必要条件となる。App::Xでは下記のようなコードになる。

    //  example/template/app_ints.h 28

    namespace App {

    inline std::ostream& operator<<(std::ostream& os, X const& x) { return os << x.ToString(); }
    }  // namespace App

他の任意のユーザ定義型に対しても、このようにすることでログ登録が可能になる。

なお、ヒューマンリーダブルな文字列でその状態を表示できる関数をユーザ定義型に与えることは、 デバッガを使用したデバッグ時にも有用である。

ユーザ定義型とそのoperator<<のname lookup

ここで、一旦Logging::Loggerの開発を止め、 Logging::Logger::set_innerでのApp::operator<<のname lookupについて考えてみることにする。

ここまでで紹介したログ取得ライブラリやそれを使うユーザ定義型等の定義、宣言の順番は、

  1. Logging::Logger
  2. App::X
  3. App::operator<<
  4. 単体テスト(Logger::set_innerのインスタンス化される場所)

となっている。 name lookupの原則に従い、App::Xの宣言は、App::operator<<より前に行われている。 これを逆にするとコンパイルできない。 しかし、Logging::Loggerは、後から宣言されたApp::operator<<を使うことができる。 多くのプログラマは、これについて気づいていないか、その理由を間違っての認識している。

その認識とは、「テンプレート内の識別子のname lookupは、 それがインスタンス化される時に行われる」というものであり、これにより 「 Logging::Loggerのname lookupは単体テスト内で行われる。 それはApp::operator<<宣言後であるためコンパイルできる」と考えることができるが、 two phase name lookupで行われるプロセスと反するため誤りである。

まずは、この認識の誤りを下記のコードで説明する。

    //  example/template/logger_0_ut.cpp 68

    namespace App2 {
    class X {
    public:
        explicit X(std::string str, int num) : str_{std::move(str)}, num_{num} {}
        std::string ToString() const { return str_ + "/" + std::to_string(num_); }
        // ...
    };
    }  // namespace App2

    namespace App3 {  // App3をApp2にすればコンパイルできる
    std::ostream& operator<<(std::ostream& os, App2::X const& x) { return os << x.ToString(); }
    }  // namespace App3

    namespace {

    TEST(Template, logger_0_X_in_AppX)
    {
        Logging::Logger::Inst().Clear();

        auto x = App2::X{"name", 3};

        using namespace App3;  // この記述は下記のエラーに効果がない

        LOGGER(1, x);  // ここがコンパイルエラーとなる
        auto line_num = __LINE__;

        auto s = Logging::Logger::InstConst().Get();

        auto exp = std::string{log_str_exp(__FILE__, line_num - 1, ":1:name/3\n")};
        ASSERT_EQ(exp, s);
    }
    }  // namespace

このコードは、もともとのコードの名前空間名をApp2とApp3にしただけのものである。 もし、前記した「認識」の内容が正しいのであれば、このコードもコンパイルできるはずであるが (実際にApp3と書いた部分をApp2に書き換えればコンパイルできる)、 実際には下記のようなエラーが発生する。

    logger_0.h:37:21: error: no match for ‘operator<<’ 
    (operand types are ‘std::basic_ostream<char>’ and ‘const App2::X’)
       37 |         oss_ << ":" << head;
          |         ~~~~~~~~~~~~^~~~~~~

エラー内容からoperator<<が発見できないことは明らかである。 単体テスト内でのusing namespace App3はLogging::Logger::set_innerの宣言より後に書かれているため、 このエラーを防ぐ効果はない。

Logging::Logger::set_innerの中でusing namespace App3とした上で、 two phase name lookupの原則に従い、 App2::XとApp3::operator<<をLogging::Loggerの宣言より前に宣言することで、 ようやくコンパイルすることができる。

名前空間Appの例と名前空間App2、App3の例での本質的な違いは、 「型Xとそのoperator<<が同じ名前空間で宣言されているかどうか」である。

名前空間Appの例の場合、型Xとそのoperator<<が同じ名前空間で宣言されているため、 ADL(実引数依存探索)が働く。 また、Logging::Logger::set_inner(x)はテンプレートであるため、two phase name lookup が使用される。 その結果、Logging::Logger::set_inner(x)でのname lookupの対象には、 「Logging::Logger::set_inner(x)がインスタンス化される場所 (単体テスト内でのLOGGER_PやLOGGERが使われている場所)より前方で宣言された名前空間App」も含まれる。 こういったメカニズムにより、 Logging::Logger::set_inner定義位置の後方で宣言されたApp::operator<<も発見できることになる。

一方で、名前空間App2、App3の例では、型XがApp2で宣言されているため、 Logging::Logger::set_inner(x)でのname lookupの対象にApp3は含ず、 App3::operator<<は発見されない(繰り返すが、インスタン化の場所直前でのusing nameには効果がない)。

型Xとそのoperator<<を同じ名前空間で宣言することは本質的に重要なことであるが、 名前空間を使用する場合、自然にそのような構造になるため、 その重要性の理由を知る必要はないように思われる。 しかし、次の例で示すようにこのメカニズムを知らずに解決することができないケースが存在する。

Ints_tのログ登録

話題はログ取得ライブラリの開発に戻る。 アプリケーションの開発では、下記のように宣言された型エイリアスを使うことは珍しくない。

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }

そのoperator<<を下記のように定義したとする。

    //  example/template/logger_0_ut.cpp 109

    namespace App {
    std::ostream& operator<<(std::ostream& os, Ints_t const& ints)
    {
        auto sep = "";

        for (auto const i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }
    }  // namespace App

単体テストは下記のように書けるが、残念ながらコンパイルエラーになり、

    //  example/template/logger_0_ut.cpp 131

    auto ints = App::Ints_t{1, 2, 3};

    auto oss = std::ostringstream{};

    oss << ints;
    ASSERT_EQ("1, 2, 3", oss.str());

下記のようなエラーメッセージが表示される。

    logger_0_ut.cpp:140:9: error: no match for ‘operator<<’
        (operand types are ‘std::ostringstream’ {aka ‘std::basic_ostringstream<char>’}
         and ‘App::Ints_t’ {aka ‘std::vector<int>’})
      140 |     oss << ints;
          |     ~~~ ^~ ~~~~
          |     |      |
          |     |      App::Ints_t {aka std::vector<int>}
          |     std::ostringstream {aka std::basic_ostringstream<char>}

Ints_tはAppで定義されているが、実際の型はstdで定義されているため、 instsの関連名前空間もstdであり、Appではない。 その結果App::operator<<は発見できず、このようなエラーになった。

LOGGERからApp::operator<<を使う場合の単体テストは下記のようになるが、 ADLによってLogging::Logger::set_inner(ints)内に導入される名前空間はstdのみであり、 前記単体テスト同様にコンパイルできない。

    //  example/template/logger_0_ints_ut.h 8

    auto ints = App::Ints_t{1, 2, 3};

    LOGGER("Ints", ints);
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto exp = std::string{log_str_exp(__FILE__, line_num - 1, ":Ints:1, 2, 3\n")};
    ASSERT_EQ(exp, s);

この解決方法は、

のようにいくつか考えられる。以下では、順を追ってこれらの問題点について解説を行う。

operator<<をstd内で宣言する

ここで解決したい問題は、すでに示した通り、 「ADLによってLogging::Logger::set_inner(ints)内に導入される名前空間はstdである」 ことにって発生する。であれば、App内でのoperator<<の宣言をstdで行えばコンパイルできるはずである。 下記はその変更を行ったコードである。

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }
    //  example/template/logger_0_std_ut.cpp 11

    namespace std {  // operator<<の定義をstdで行う
    ostream& operator<<(std::ostream& os, App::Ints_t const& ints)
    {
        auto sep = "";

        for (auto const& i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }
    }  // namespace std

上記コードはtwo phase name lookup等の効果により、想定通りコンパイルできるが、 stdをユーザが拡張することは一部の例外を除き未定義動作を引き起こす可能性があり、 たとえこのコードがうまく動作したとしても (実際、このコードはこのドキュメント作成時には正常動作している)、 未来においてその保証はなく、このようなプログラミングは厳に避けるべきである。

operator<<をグローバル名前空間内で宣言する

すでに述べた通り、 「ADLによってLogging::Logger::set_inner(ints)内に導入される名前空間はstdのみである」ため、 この関数の中でのname lookupに使用される名前空間は、std、グローバル名前空間、 Loggerを宣言しているLoggingの3つである。

ここでは、下記のコードのようにグローバル名前空間内でのoperator<<の宣言を試す。

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }
    //  example/template/logger_0_global_ut.cpp 10

    // グローバル名前空間
    std::ostream& operator<<(std::ostream& os, App::Ints_t const& ints)
    {
        auto sep = "";

        for (auto const& i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }

このドキュメントで使用しているg++ではこのコードはコンパイルでき、 動作も問題ないように思われるが、clang++では以下のようなエラーが発生し、コンパイルできない。

    ./logger_0.h:37:21: error: call to function 'operator<<' that is neither 
    visible in the tem plate definition nor found by argument-dependent lookup
            oss_ << ":" << head;

この理由は「two phase name lookup」の後半で詳しく解説したので、ここでは繰り返さないが、 このようなコードを使うと、コード解析ツール等が使用できなくなることがあるため、 避けるべきである 。

多くのプログラマは、コードに問題があるとしても、 それが意図通りに動くように見えるのであればその問題を無視する。 今回のような難題に対しては、なおさらそのような邪悪な欲求に負けやすい。 そのような観点でclang++が吐き出したエラーメッセージを眺めると、上記したメッセージの後に、 下記のような出力を見つけるかもしれない。

    logger_0_global_ut.cpp:13:15: note: 'operator<<' should be declared prior to the call site
    std::ostream& operator<<(std::ostream& os, App::Ints_t const& ints)

clang++は「LOGGERの前にoperator<<を宣言せよ」と言っている。 実際そうすれば、clang++でのコンパイルも通り、単体テストもパスする。 しかし、それには下記のような問題がある。

以上述べた理由からこのアイデアを選択するべきではない。

operator<<をLogging内で宣言する

前節でのグローバル名前空間内でのoperator<<の宣言はうまく行かなかったので、 同様のことをLoggingで試す。

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }
    //  example/template/logger_0_logging_ut.cpp 10

    namespace Logging {  // operator<<の定義をLoggingで行う
    std::ostream& operator<<(std::ostream& os, App::Ints_t const& ints)
    {
        auto sep = "";

        for (auto const& i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }
    }  // namespace Logging

動作はするものの、当然ながら結果は「operator<<をグローバル名前空間内で宣言する」 で述べた状況とほぼ同様であるため、このアイデアを採用することはできない。

Logging::Logger::set_inner(ints)内でusing namespace Appを行う

Logging::Logger::set_inner(ints)内でusing namespace Appを行えば、 意図通りに動作させることができるが、App内のロギングは名前空間Loggingに依存するため、 AppとLoggingが循環した依存関係を持ってしまう。 また、LoggingはAppに対して上位概念であるため、依存関係逆転の原則(DIP)にも反する。 よって、このアイデアを採用することはできない。

Ints_tを構造体としてApp内に宣言する

App::Ints_t用のoperator<<がLogging::Logger::set_inner内でname lookup出来ない理由は、 これまで述べてきたようにApp::Inst_tの関連名前空間がAppではなく、stdになってしまうからである。

これを回避するためにはその原因を取り払えばよく、 つまり、App::Inst_tの関連名前空間がAppになるようにすればよい。 これを実現するために、次のコードを試してみる。

    //  example/template/logger_0_struct_ut.cpp 10

    namespace App {                     // Ints_tの宣言はApp
    struct Ints_t : std::vector<int> {  // エイリアスではなく、継承を使う
        using vector::vector;           // 継承コンストラクタ
    };

    // App内
    std::ostream& operator<<(std::ostream& os, Ints_t const& ints)
    {
        auto sep = "";

        for (auto const& i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }
    }  // namespace App

上記のコードでは、

としているため、エイリアスで宣言されたInts_tと等価である。 C++03では、継承コンストラクタが使えなかったため、 上記のような構造体を定義するためには、 std::vectorのすべてのコンストラクタと等価なコンストラクタをApp::Ints_t内に定義することが必要で、 実践的にはこのようなアイデアは使い物にならなかったが、 C++11での改善により、実践的なアイデアとして使用できるようになった。

実際、名前空間の問題もなく、すでに示した単体テストもパスするので有力な候補となるが、 若干の「やりすぎ感」は否めない。

operator<<を使わない

色々なアイデアを試してみたが、これまでの議論ではこれといった解決方法を発見できなかった。 「バーニーの祈り」 が言っている通り、時にはどうにもならないことを受け入れることも重要である。 LOGGERの中でname lookupできる、エイリアスApp::Ints_tのoperator<<の開発をあきらめ、 ここでは一旦、下記のような受け入れがたいコードを受け入れることにする。

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }
    //  example/template/logger_0_no_put_to_ut.cpp 10

    namespace App {  // App::Ints_tのoperator<<とToStringをApp内で定義
    namespace {      // operator<<は外部から使わない
    std::ostream& operator<<(std::ostream& os, Ints_t const& ints)
    {
        auto sep = "";

        for (auto const& i : ints) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }
    }  // namespace

    // Ints_tオブジェクトをstd::stringに変換する
    // この変換によりロガーに渡すことができる
    std::string ToString(Ints_t const& inst)
    {
        auto oss = std::ostringstream{};

        oss << inst;

        return oss.str();
    }
    }  // namespace App

当然だが、恥を忍んで受け入れたコードにも単体テストは必要である。

    //  example/template/logger_0_no_put_to_ut.cpp 44

    auto ints = App::Ints_t{1, 2, 3};

    // ToStringのテスト
    ASSERT_EQ("1, 2, 3", App::ToString(ints));

    // LOGGERのテスト
    LOGGER("Ints", App::ToString(ints));
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto exp = std::string{log_str_exp(__FILE__, line_num - 1, ":Ints:1, 2, 3\n")};
    ASSERT_EQ(exp, s);

上記コードから明らかな通り、App::Ints_tのインスタンスをログ登録する場合、 App::ToString()によりstd::stringへ変換する必要があり、残念なインターフェースとなっている。

Ints_tのログ登録のまとめ

製品開発では、満足できる仕様の関数やクラスが作れず、妥協せざるを得ないことはよくあることである。 このような場合、将来、良いアイデアが見つかった時に備えて、 妥協コードを簡単に修正できるようなレベルにした後、捲土重来を期してさっさと退却するのがベストである。 ただし、漫然と過ごしても良いアイデアは浮かばない。 時間を作り、関連書籍やウェブドキュメント等を読み、学習を継続する必要があることは言うまでもない。

Nstdライブラリの開発

operator<<を使わない」で導入したコードは、短いながらも汎用性が高い。 このようなコードをローカルなファイルに閉じ込めてしまうと、 コードクローンや、車輪の再発明による開発効率の低下につながることがある。

通常、プロジェクトの全ファイルから参照可能で且つ、 プロジェクトの他のパッケージに非依存なパッケージを用意することで、このような問題を回避できる。

ここでは、そのようなパッケージをNstd(not standard library)とし、名前空間も同様に宣言する。 そうした場合、この章の例題で使用している名前空間の依存関係は下記のようになる。

このように整理された依存関係は、 大規模ソフトウェア開発においては特に重要であり、決して循環しないように維持しなければならない。

Nstdライブラリを使用したリファクタリング

すでに述べた通り、「operator<<を使わない」で導入したコードは、Nstdで定義するべきである。 その場合、下記のようにさらに一般化するのが良いだろう。

    //  example/template/nstd_0.h 4

    namespace Nstd {

    template <typename T>
    std::ostream& operator<<(std::ostream& os, std::vector<T> const& vec)
    {
        auto sep = "";

        for (auto const& i : vec) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }

    template <typename T>
    std::string ToString(std::vector<T> const& vec)
    {
        auto oss = std::ostringstream{};

        oss << vec;

        return oss.str();
    }
    }  // namespace Nstd

その単体テストは下記のようになる。

    //  example/template/nstd_0_ut.cpp 13

    auto const ints = App::Ints_t{1, 2, 3};

    {
        auto oss = std::ostringstream{};

        using namespace Nstd;
        oss << ints << 4;
        ASSERT_EQ("1, 2, 34", oss.str());
    }
    {
        auto oss = std::ostringstream{};

        Nstd::operator<<(oss, ints) << 4;  // 念のためこの形式でもテスト
        ASSERT_EQ("1, 2, 34", oss.str());
    }

    ASSERT_EQ("1, 2, 3", Nstd::ToString(ints));

勘のいい読者なら、このコードをLOGGERから利用することで、 App:Ints_tのログ登録問題を解消できると思うかもしれない。 実際その通りなのであるが、そうした場合、 std::list等の他のコンテナや配列には対応できないという問題が残るため、 以降もしばらくNstdの開発を続ける。

安全なvector

std::vector、std::basic_string、std::array等の配列型コンテナは、

という仕様になっているが、 ここではoperator[]にも範囲のチェックを行う配列型コンテナが必要になった場合について考える。

手始めにoperator[]にも範囲のチェックを行うstd::vector相当のコンテナSafeVectorを作ると、 下記のコードのようになる。

    //  example/template/safe_vector_ut.cpp 10

namespace Nstd {

template <typename T>
struct SafeVector : std::vector<T> {
    using std::vector<T>::vector;  // 継承コンストラクタ

    using base_type = std::vector<T>;
    using size_type = typename base_type::size_type;

    typename base_type::reference       operator[](size_type i) { return this->at(i); }
    typename base_type::const_reference operator[](size_type i) const { return this->at(i); }
};
}  // namespace Nstd

このコードで行ったことは、

である。単体テストは下記のようになる。

    //  example/template/safe_vector_ut.cpp 30

    {
        auto v = Nstd::SafeVector<int>(10);  // ()での初期化

        ASSERT_EQ(10, v.size());
    }
    {
        auto const v = Nstd::SafeVector<int>{10};

        ASSERT_EQ(1, v.size());
        ASSERT_EQ(10, v[0]);
        ASSERT_THROW(v[1], std::out_of_range);  // エクセプションの発生
    }
    {
        auto v = Nstd::SafeVector<std::string>{"1", "2", "3"};

        ASSERT_EQ(3, v.size());
        ASSERT_EQ((std::vector<std::string>{"1", "2", "3"}), v);
        ASSERT_THROW(v[3], std::out_of_range);  // エクセプションの発生
    }
    {
        auto const v = Nstd::SafeVector<std::string>{"1", "2", "3"};

        ASSERT_EQ(3, v.size());
        ASSERT_EQ((std::vector<std::string>{"1", "2", "3"}), v);
        ASSERT_THROW(v[3], std::out_of_range);  // エクセプションの発生
    }

安全な配列型コンテナ

配列型コンテナはすでに述べたようにstd::vectorの他にすくなともstd::basic_string、 std::arrayがあるため、それらにも範囲チェックを導入する。

std::basic_stringはstd::vectorとほぼ同様に下記のようになる。

    //  example/template/safe_vector_ut.cpp 62
    namespace Nstd {

    struct SafeString : std::string {
        using std::string::string;  // 継承コンストラクタ

        using base_type = std::string;
        using size_type = typename base_type::size_type;

        typename base_type::reference       operator[](size_type i) { return this->at(i); }
        typename base_type::const_reference operator[](size_type i) const { return this->at(i); }
    };
    }  // namespace Nstd

std::stringはstd::basic_string<char>のエイリアスであるため、 上記では、通常使われる形式であるstd::stringを継承したSafeStringを定義した。

この単体テストはSafeVectorの場合と同様に下記のようになる。

    //  example/template/safe_vector_ut.cpp 80

    {
        auto s = Nstd::SafeString{"0123456789"};

        ASSERT_EQ(10, s.size());
        ASSERT_EQ("0123456789", s);
        ASSERT_THROW(s[10], std::out_of_range);
    }
    {
        auto const s = Nstd::SafeString(3, 'c');  // ()での初期化が必要

        ASSERT_EQ(3, s.size());
        ASSERT_EQ("ccc", s);
    }

std::arrayでは少々事情が異なるが、 std::vectorのコードパターンをそのまま適用すると下記のようになる。

    //  example/template/safe_vector_ut.cpp 101

    namespace Nstd {

    template <typename T, size_t N>
    struct SafeArray : std::array<T, N> {
        using std::array<T, N>::array;  // 継承コンストラクタ

        using base_type = std::array<T, N>;
        using size_type = typename base_type::size_type;

        typename base_type::reference       operator[](size_type i) { return this->at(i); }
        typename base_type::const_reference operator[](size_type i) const { return this->at(i); }
    };
    }  // namespace Nstd

ただし、この実装には問題がある。

    //  example/template/safe_vector_ut.cpp 122

    auto sa_not_init = Nstd::SafeArray<int, 3>{};

    ASSERT_EQ(3, sa_not_init.size());
    ASSERT_THROW(sa_not_init[3], std::out_of_range);

上記コードでは、その問題が露見することはないが、以下のコードはコンパイルできない。

    //  example/template/safe_vector_ut.cpp 132

    // std::initializer_listを引数とするコンストラクタが未定義
    auto sa_init = Nstd::SafeArray<int, 3>{1, 2, 3};

    // デフォルトコンストラクタがないため、未初期化
    Nstd::SafeArray<int, 3> const sa_const;

std::arrayにはコンストラクタが明示的に定義されていないため、 std::arrayにはデフォルトで自動生成される

以外のコンストラクタがないことが原因である。 従って、SafeArray(std::initializer_list)が定義されず前述したようにコンパイルエラーとなる。

この問題に対処したのが以下のコードである。

    //  example/template/safe_vector_ut.cpp 146

    namespace Nstd {

    template <typename T, size_t N>
    struct SafeArray : std::array<T, N> {
        using std::array<T, N>::array;  // 継承コンストラクタ
        using base_type = std::array<T, N>;

        template <typename... ARGS>  // コンストラクタを定義
        SafeArray(ARGS... args) : base_type{args...}
        {
        }

        using size_type = typename base_type::size_type;

        typename base_type::reference       operator[](size_type i) { return this->at(i); }
        typename base_type::const_reference operator[](size_type i) const { return this->at(i); }
    };
    }  // namespace Nstd

上記コードで注目すべきは、パラメータパックをテンプレートパラメータとしたコンストラクタである。 これにより、前例ではコンパイルすらできなかった下記のような初期化子リストを用いた単体テストが、 このコンストラクタによりパスするようになった。

    //  example/template/safe_vector_ut.cpp 181
    {
        auto sa_init = Nstd::SafeArray<int, 3>{1, 2, 3};

        ASSERT_EQ(3, sa_init.size());
        ASSERT_EQ(1, sa_init[0]);
        ASSERT_EQ(2, sa_init[1]);
        ASSERT_EQ(3, sa_init[2]);
        ASSERT_THROW(sa_init[3], std::out_of_range);
    }
    {
        auto const sa_string_const = Nstd::SafeArray<std::string, 5>{"1", "2", "3"};

        ASSERT_EQ(5, sa_string_const.size());
        ASSERT_EQ("1", sa_string_const[0]);
        ASSERT_EQ("2", sa_string_const[1]);
        ASSERT_EQ("3", sa_string_const[2]);
        ASSERT_EQ("", sa_string_const[3]);
        ASSERT_EQ("", sa_string_const[4]);
        ASSERT_THROW(sa_string_const[5], std::out_of_range);
    }

この効果を生み出した上記を抜粋した下記のコードには解説が必要だろう。

    //  example/template/safe_vector_ut.cpp 155

    template <typename... ARGS>  // コンストラクタを定義
    SafeArray(ARGS... args) : base_type{args...}
    {
    }

一般にコンストラクタには「メンバ変数の初期化」と「基底クラスの初期化」が求められるが、 SafeArrayにはメンバ変数が存在しないため、 このコンストラクタの役割は「基底クラスの初期化」のみとなる。 基底クラスstd::array(上記例ではbase_typeにエイリアスしている) には名前が非規定の配列メンバのみを持つため、 これを初期化するためには初期化子リスト (「初期化子リストコンストラクタ」、 「一様初期化」参照)を用いるのが良い。

ということは、SafeArrayの初期化子リストコンストラクタには、 「基底クラスstd::arrayに初期子リストを与えて初期化する」形式が必要になる。 値を持つパラメータパックは初期化子リストに展開できるため、 ここで必要な形式はパラメータパックとなる。 これを実現したのが上記に抜粋したわずか数行のコードである。

初期化子リストの副作用

上記SafeArrayの初期化子リストコンストラクタは以下のようなコードを許可しない。

    //  example/template/safe_vector_ut.cpp 213
    {
        auto sa_init = Nstd::SafeArray<int, 3>{1.0, 2, 3};

        ASSERT_EQ(3, sa_init.size());
        ASSERT_EQ(1, sa_init[0]);
        ASSERT_EQ(2, sa_init[1]);
        ASSERT_EQ(3, sa_init[2]);
        ASSERT_THROW(sa_init[3], std::out_of_range);
    }

このコードをコンパイルすると、

    safe_vector_ut.cpp:147:41: error: narrowing conversion of ‘
                                        args#0’ from ‘double’ to ‘int’ -Werror=narrowing]
      147 |     SafeArray(ARGS... args) : base_type{args...}
          |                                         ^~~~

のようなエラーが出力されるが、

が原因である。これは意図しない縮小変換によるバグを防ぐ良い機能だと思うが、 ここではテンプレートメタプログラミングのテクニックを解説するため、 あえてこのコンパイルエラーを起こさないSafeArray2を開発する (言うまでもないが、通常のソフトウェア開発では、 縮小変換によるコンパイルエラーを回避するようなコードを書いてはならない)。

SafeArray2のコードは、

等のメタ関数系のテクニックが必要になるため、 まずはこれらを含めたテンプレートのテクニックについて解説し、 その後SafeArray2を見ていくことにする。

メタ関数のテクニック

本章で扱うメタ関数とは、型、定数、クラステンプレート等からなるテンプレート引数から、 型、エイリアス、定数等を宣言、定義するようなクラステンプレート、関数テンプレート、 定数テンプレート、エイリアステンプレートを指す (本章ではこれらをまとめて単にテンプレート呼ぶことがある)。

STLのtype_traits

メタ関数ライブラリの代表的実装例はSTLの type_traitsである。

ここでは、よく使ういくつかのtype_traitsテンプレートの使用例や解説を示す。

std::true_type/std::false_type

std::true_type/std::false_typeは真/偽を返すSTLメタ関数群の戻り型となる型エイリアスであるため、 最も使われるテンプレートの一つである。

これらは、下記で確かめられる通り、後述するstd::integral_constantを使い定義されている。

    //  example/template_cpp17/type_traits_ut.cpp 13

    // std::is_same_vの2パラメータが同一であれば、std::is_same_v<> == true
    static_assert(std::is_same_v<std::integral_constant<bool, true>, std::true_type>);
    static_assert(std::is_same_v<std::integral_constant<bool, false>, std::false_type>);

それぞれの型が持つvalue定数は、下記のように定義されている。

    //  example/template_cpp17/type_traits_ut.cpp 20

    static_assert(std::true_type::value, "must be true");
    static_assert(!std::false_type::value, "must be false");

これらが何の役に立つのか直ちに理解することは難しいが、 true/falseのメタ関数版と考えれば、追々理解できるだろう。

以下に簡単な使用例を示す。

    //  example/template_cpp17/type_traits_ut.cpp 29

    // 引数の型がintに変換できるかどうかを判定する関数
    // decltypeの中でのみ使用されるため、定義は不要
    constexpr std::true_type  IsCovertibleToInt(int);  // intに変換できる型はこちら
    constexpr std::false_type IsCovertibleToInt(...);  // それ以外はこちら

上記の単体テストは下記のようになる。

    //  example/template_cpp17/type_traits_ut.cpp 40

    static_assert(decltype(IsCovertibleToInt(1))::value);
    static_assert(decltype(IsCovertibleToInt(1u))::value);
    static_assert(!decltype(IsCovertibleToInt(""))::value);  // ポインタはintに変換不可

    struct ConvertibleToInt {
        operator int();
    };

    struct NotConvertibleToInt {};

    static_assert(decltype(IsCovertibleToInt(ConvertibleToInt{}))::value);
    static_assert(!decltype(IsCovertibleToInt(NotConvertibleToInt{}))::value);

    // なお、IsCovertibleToInt()やConvertibleToInt::operator int()は実際に呼び出されるわけでは
    // ないため、定義は必要なく宣言のみがあれば良い。

IsCovertibleToIntの呼び出しをdecltypeのオペランドにすることで、 std::true_typeかstd::false_typeを受け取ることができる。

std::integral_constant

std::integral_constantは 「テンプレートパラメータとして与えられた型とその定数から新たな型を定義する」 クラステンプレートである。

以下に簡単な使用例を示す。

    //  example/template_cpp17/type_traits_ut.cpp 62

    using int3 = std::integral_constant<int, 3>;

    // std::is_same_vの2パラメータが同一であれば、std::is_same_v<> == true
    static_assert(std::is_same_v<int, int3::value_type>);
    static_assert(std::is_same_v<std::integral_constant<int, 3>, int3::type>);
    static_assert(int3::value == 3);

    using bool_true = std::integral_constant<bool, true>;

    static_assert(std::is_same_v<bool, bool_true::value_type>);
    static_assert(std::is_same_v<std::integral_constant<bool, true>, bool_true::type>);
    static_assert(bool_true::value == true);

また、すでに示したようにstd::true_type/std::false_typeを実装するためのクラステンプレートでもある。

std::is_same

すでに上記の例でも使用したが、std::is_sameは2つのテンプレートパラメータが

から派生した型となる。

以下に簡単な使用例を示す。

    //  example/template_cpp17/type_traits_ut.cpp 99

    static_assert(std::is_same<int, int>::value);
    static_assert(std::is_same<int, int32_t>::value);   // 64ビットg++/clang++
    static_assert(!std::is_same<int, int64_t>::value);  // 64ビットg++/clang++
    static_assert(std::is_same<std::string, std::basic_string<char>>::value);
    static_assert(std::is_same<typename std::vector<int>::reference, int&>::value);

また、 C++17で導入されたstd::is_same_vは、定数テンプレートを使用し、 下記のように定義されている。

    //  example/template_cpp17/type_traits_ut.cpp 90

    template <typename T, typename U>
    constexpr bool is_same_v{std::is_same<T, U>::value};
    //  example/template_cpp17/type_traits_ut.cpp 108

    static_assert(is_same_v<int, int>);
    static_assert(is_same_v<int, int32_t>);   // 64ビットg++/clang++
    static_assert(!is_same_v<int, int64_t>);  // 64ビットg++/clang++
    static_assert(is_same_v<std::string, std::basic_string<char>>);
    static_assert(is_same_v<typename std::vector<int>::reference, int&>);

このような簡潔な記述の一般形式は、

   T::value  -> T_v
   T::type   -> T_t

のように定義されている(このドキュメントのほとんど場所では、簡潔な形式を用いる)。

第1テンプレートパラメータが第2テンプレートパラメータの基底クラスかどうかを判断する std::is_base_ofを使うことで下記のようにstd::is_sameの基底クラス確認することもできる。

    //  example/template_cpp17/type_traits_ut.cpp 117

    static_assert(std::is_base_of_v<std::true_type, std::is_same<int, int>>);
    static_assert(std::is_base_of_v<std::false_type, std::is_same<int, char>>);

std::enable_if

std::enable_ifは、bool値である第1テンプレートパラメータが

下記のコードはクラステンプレートの特殊化を用いたstd::enable_ifの実装例である。

    //  example/template_cpp17/type_traits_ut.cpp 124

    template <bool T_F, typename T = void>
    struct enable_if;

    template <typename T>
    struct enable_if<true, T> {
        using type = T;
    };

    template <typename T>
    struct enable_if<false, T> {  // メンバエイリアスtypeを持たない
    };

    template <bool COND, typename T = void>
    using enable_if_t = typename enable_if<COND, T>::type;

std::enable_ifの使用例を下記に示す。

    //  example/template_cpp17/type_traits_ut.cpp 148

    static_assert(std::is_same_v<void, std::enable_if_t<true>>);
    static_assert(std::is_same_v<int, std::enable_if_t<true, int>>);

実装例から明らかなように

となるため、下記のコードはコンパイルできない。

    //  example/template_cpp17/type_traits_ut.cpp 155

    // 下記はill-formedとなるため、コンパイルできない。
    static_assert(std::is_same_v<void, std::enable_if_t<false>>);
    static_assert(std::is_same_v<int, std::enable_if_t<false, int>>);

std::enable_ifのこの特性と後述するSFINAEにより、 様々な静的ディスパッチを行うことができる。

std::conditional

std::conditionalは、bool値である第1テンプレートパラメータが

をメンバ型typeとして宣言する。

下記のコードはクラステンプレートの特殊化を用いたstd::conditionalの実装例である。

    //  example/template_cpp17/type_traits_ut.cpp 164

    template <bool T_F, typename, typename>
    struct conditional;

    template <typename T, typename U>
    struct conditional<true, T, U> {
        using type = T;
    };

    template <typename T, typename U>
    struct conditional<false, T, U> {
        using type = U;
    };

    template <bool COND, typename T, typename U>
    using conditional_t = typename conditional<COND, T, U>::type;

std::conditionalの使用例を下記に示す。

    //  example/template_cpp17/type_traits_ut.cpp 189

    static_assert(std::is_same_v<int, std::conditional_t<true, int, char>>);
    static_assert(std::is_same_v<char, std::conditional_t<false, int, char>>);

std::is_void

std::is_voidはテンプレートパラメータの型が

から派生した型となる。

以下に簡単な使用例を示す。

    //  example/template_cpp17/type_traits_ut.cpp 82

    static_assert(std::is_void<void>::value);
    static_assert(!std::is_void<int>::value);
    static_assert(!std::is_void<std::string>::value);

is_void_xxxの実装

ここではstd::is_voidに似た以下のような仕様を持ついくつかのテンプレートis_void_xxxの実装を考える。

テンプレートパラメータ 戻り値
void true
非void false

それぞれのis_void_xxxは下記テーブルで示した言語機能を使用して実装する。

is_void_xxx 実装方法
is_void_f 関数テンプレートの特殊化
is_void_s クラステンプレートの特殊化
is_void_sfinae_f FINAEと関数テンプレートのオーバーロード
is_void_sfinae_s FINAEとクラステンプレートの特殊化
is_void_concept_s コンセプトとクラステンプレートの特殊化
is_void_ena_s std::enable_ifによるSFINAEとクラステンプレートの特殊化
is_void_cond_s std::conditionalと関数テンプレートの特殊化

なお、実装例をシンプルに保つため、 理解の妨げとなり得る下記のような正確性(例外条件の対応)等のためのコードを最低限に留めた。

これは、「テンプレートプログラミングでの有用なテクニックの解説」 というここでの目的を見失わないための措置である。

is_void_f

関数テンプレートの特殊化を使用したis_void_fの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 8

    template <typename T>
    constexpr bool is_void_f() noexcept
    {
        return false;
    }

    template <>
    constexpr bool is_void_f<void>() noexcept
    {
        return true;
    }

    template <typename T>
    constexpr bool is_void_f_v{is_void_f<T>()};

単純なので解説は不要だろう。これらの単体テストは下記のようになる。

    //  example/template/is_void_ut.cpp 28

    static_assert(!is_void_f_v<int>);
    static_assert(!is_void_f_v<std::string>);
    static_assert(is_void_f_v<void>);

関数テンプレートの特殊化には、

のような制限があるため用途は限られるが、関数テンプレートはオーバーロードすることが可能である。

is_void_s

クラステンプレートの特殊化を使用したis_void_sの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 36

    template <typename T>
    struct is_void_s {
        static constexpr bool value{false};
    };

    template <>
    struct is_void_s<void> {
        static constexpr bool value{true};
    };

    template <typename T>
    constexpr bool is_void_s_v{is_void_s<T>::value};

is_void_fと同様に単純なので解説は不要だろう。これらの単体テストは下記のようになる。

    //  example/template/is_void_ut.cpp 54

    static_assert(!is_void_s_v<int>);
    static_assert(!is_void_s_v<std::string>);
    static_assert(is_void_s_v<void>);

is_void_sfinae_f

SFINAEを使用した関数テンプレートis_void_sfinae_fの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 62

    namespace Inner_ {

    // T == void
    template <typename T>
    constexpr auto is_void_sfinae_f_detector(void const* v, T const* t) noexcept
        -> decltype(t = v, bool{})  // T != voidの場合、t = vはill-formed
                                    // T == voidの場合、well-formedでbool型生成
    {
        return true;
    }

    // T != void
    template <typename T>
    constexpr auto is_void_sfinae_f_detector(void const*, T const*) noexcept
        -> decltype(sizeof(T), bool{})  // T != voidの場合、well-formedでbool型生成
                                        // T == voidの場合、sizeof(T)はill-formed
    {
        return false;
    }
    }  // namespace Inner_

    template <typename T>
    constexpr bool is_void_sfinae_f() noexcept
    {
        return Inner_::is_void_sfinae_f_detector(nullptr, static_cast<T*>(nullptr));
    }

    template <typename T>
    constexpr bool is_void_sfinae_f_v{is_void_sfinae_f<T>()};

関数テンプレートである2つのis_void_sfinae_f_detectorのオーバーロードにSFINAEを使用している。

1つ目のis_void_sfinae_f_detectorでは、

T t = v の診断(コンパイル)
== void well-formed
!= void ill-formed

であるため、Tがvoidの時のみname lookupの対象になる。

2つ目のis_void_sfinae_f_detectorでは、

T sizeof(T)の診断(コンパイル)
== void ill-formed
!= void well-formed

であるため、Tが非voidの時のみname lookupの対象になる。

is_void_sfinae_fはこの性質を利用し、

となる。念のため単体テストを示すと下記のようになる。

    //  example/template/is_void_ut.cpp 97

    static_assert(!is_void_sfinae_f_v<int>);
    static_assert(!is_void_sfinae_f_v<std::string>);
    static_assert(is_void_sfinae_f_v<void>);

一般にファイル外部に公開するテンプレートは、 コンパイルの都合上ヘッダファイルにその全実装を記述することになる。 これは、本来外部公開すべきでない実装の詳細である is_void_sfinae_f_detectorのようなテンプレートに関しては大変都合が悪い。 というのは、外部から使用されたくない実装の詳細が使われてしまうことがあり得るからである。 上記の例では、こういうことに備え 「これは外部非公開である」ということを示す名前空間Inner_ を導入した。

関数テンプレートはクラステンプレート内にも定義することができるため、 is_void_sfinae_fは下記のように実装することも可能である。この場合、名前空間Inner_は不要になる。

    //  example/template/is_void_ut.cpp 106

    template <typename T>
    class is_void_sfinae_f {
        // U == void
        template <typename U>
        static constexpr auto detector(void const* v, U const* u) noexcept
            -> decltype(u = v, bool{})  // U != voidの場合、t = vはill-formed
                                        // U == voidの場合、well-formedでbool型生成
        {
            return true;
        }

        // U != void
        template <typename U>
        static constexpr auto detector(void const*, U const*) noexcept
            -> decltype(sizeof(U), bool{})  // U != voidの場合、well-formedでbool型生成
                                            // U == voidの場合、ill-formed
        {
            return false;
        }

    public:
        static constexpr bool value{is_void_sfinae_f::detector(nullptr, static_cast<T*>(nullptr))};
    };

    template <typename T>
    constexpr bool is_void_sfinae_f_v{is_void_sfinae_f<T>::value};
    //  example/template/is_void_ut.cpp 138

    static_assert(!is_void_sfinae_f_v<int>);
    static_assert(!is_void_sfinae_f_v<std::string>);
    static_assert(is_void_sfinae_f_v<void>);

is_void_sfinae_s

SFINAEを使用したクラステンプレートis_void_sfinae_sの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 147

    namespace Inner_ {
    template <typename T>
    T*& t2ptr();  // 定義は不要
    }  // namespace Inner_

    template <typename T, typename = void*&>
    struct is_void_sfinae_s : std::false_type {
    };

    template <typename T>
    struct is_void_sfinae_s<
        T,
        // T != voidの場合、ill-formed
        // T == voidの場合、well-formedでvoid*&生成
        decltype(Inner_::t2ptr<T>() = Inner_::t2ptr<void>())

        > : std::true_type {
    };

    template <typename T>
    constexpr bool is_void_sfinae_s_v{is_void_sfinae_s<T>::value};

1つ目のis_void_sfinae_sはプライマリテンプレートである。 is_void_sfinae_sの特殊化がname lookupの対象の中に見つからなかった場合、 これが使われる。

2つ目のis_void_sfinae_sは、上記を抜粋した下記のコード

    //  example/template/is_void_ut.cpp 163

    // T != voidの場合、ill-formed
    // T == voidの場合、well-formedでvoid*&生成
    decltype(Inner_::t2ptr<T>() = Inner_::t2ptr<void>())

がT == voidの時のみ、well-formedになり、このテンプレートは下記のようにインスタンス化される。

    struct is_void_sfinae_s<void, void*&>

この形状はプライマリテンプレートの

とした場合の、つまりプライマリテンプレートを

    struct is_void_sfinae_s<void>   // プライマリテンプレート

としてインスタンス化した場合と一致する。 プライマリと特殊化が一致した場合、特殊化されたものがname lookupで選択される。

T != voidの場合、 2つ目のis_void_sfinae_sはill-formedになり、name lookupの対象から外れるため、 プライマリが選択される。

以上をまとめると、

T is_void_sfinae_sの基底クラス
== void std::true_type
!= void std::false_type

となる。以下の単体テストによって、このことを確かめることができる。

    //  example/template/is_void_ut.cpp 180

    static_assert(!is_void_sfinae_s_v<int>);
    static_assert(std::is_base_of_v<std::false_type, is_void_sfinae_s<int>>);

    static_assert(!is_void_sfinae_s_v<std::string>);
    static_assert(std::is_base_of_v<std::false_type, is_void_sfinae_s<std::string>>);

    static_assert(is_void_sfinae_s_v<void>);
    static_assert(std::is_base_of_v<std::true_type, is_void_sfinae_s<void>>);

上記コードのように「プライマリテンプレートのデフォルトパラメータ」と、

    //  example/template/is_void_ut.cpp 163

    // T != voidの場合、ill-formed
    // T == voidの場合、well-formedでvoid*&生成
    decltype(Inner_::t2ptr<T>() = Inner_::t2ptr<void>())

が「well-formedであった場合に生成される型」が一致することを利用した静的ディスパッチは、 SFINAEとクラステンプレートの特殊化を組み合わせたメタ関数の典型的な実装パターンである。 ただし、一般にはill-formedを起こすためにst::enable_ifを使うことが多いため、 「is_void_ena_sの実装」でその例を示す。

is_void_concept_s

is_void_sfinae_sの実装で使用したSFINAEを回避し、 コンセプトを使用することで可読性の向上が見込める。 以下の実装で使用したsame_asは<concepts>で定義されているコンセプトと同様のものである。

    //  example/template/is_void_ut.cpp 193

    template <typename T>
    struct is_void_concept_s : std::false_type {
    };

    template <typename T>
    requires std::same_as<T, void>  // コンセプトによるTの制約
    struct is_void_concept_s<T> : std::true_type {
    };
    //  example/template/is_void_ut.cpp 207

    static_assert(!is_void_concept_s<int>::value);
    static_assert(std::is_base_of_v<std::false_type, is_void_concept_s<int>>);

    static_assert(!is_void_concept_s<std::string>::value);
    static_assert(std::is_base_of_v<std::false_type, is_void_concept_s<std::string>>);

    static_assert(is_void_concept_s<void>::value);
    static_assert(std::is_base_of_v<std::true_type, is_void_concept_s<void>>);

下記に示した通り、テンプレート特殊化はクラスのみなく定数に対しても使用することができる。

    //  example/template/is_void_ut.cpp 220

    template <typename T>
    constexpr bool is_void_concept_s_v = false;

    template <typename T>
    requires std::same_as<T, void>
    constexpr bool is_void_concept_s_v<T> = true;

以下に示した通り、is_void_sfinae_sの実装で示した定数テンプレートのテストと同様になっている。

    //  example/template/is_void_ut.cpp 232

    static_assert(!is_void_concept_s_v<int>);
    static_assert(!is_void_concept_s_v<std::string>);
    static_assert(is_void_concept_s_v<void>);

is_void_ena_s

std::enable_ifによるSFINAEとクラステンプレートの特殊化を使用した is_void_ena_sの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 240
    template <typename T, typename = void>
    struct is_void_ena_s : std::false_type {
    };

    template <typename T>
    struct is_void_ena_s<
        T,
        typename std::enable_if_t<is_void_f<T>()>
        > : std::true_type {
    };

    template <typename T>
    constexpr bool is_void_ena_s_v{is_void_ena_s<T>::value};

この例では、「is_void_sfinae_sの実装」の

    //  example/template/is_void_ut.cpp 163

    // T != voidの場合、ill-formed
    // T == voidの場合、well-formedでvoid*&生成
    decltype(Inner_::t2ptr<T>() = Inner_::t2ptr<void>())

で示したSFINAEの処理を上記を抜粋した下記のコード

    //  example/template/is_void_ut.cpp 250

    typename std::enable_if_t<is_void_f<T>()>

で行っている。 std::enable_ifの値パラメータis_void_f<T>()は、「is_void_fの実装」で示したものである。

単体テストは、「is_void_sfinae_sの実装」で示したものとほぼ同様で、以下のようになる。

    //  example/template/is_void_ut.cpp 264

    static_assert(!is_void_ena_s_v<int>);
    static_assert(std::is_base_of_v<std::false_type, is_void_ena_s<int>>);

    static_assert(!is_void_ena_s_v<std::string>);
    static_assert(std::is_base_of_v<std::false_type, is_void_ena_s<std::string>>);

    static_assert(is_void_ena_s_v<void>);
    static_assert(std::is_base_of_v<std::true_type, is_void_ena_s<void>>);

is_void_cond_s

std::conditionalと関数テンプレートの特殊化を使用したis_void_cond_sの実装は以下のようになる。

    //  example/template/is_void_ut.cpp 277
    template <typename T>
    struct is_void_cond_s : std::conditional_t<is_void_f<T>(), std::true_type, std::false_type> {
    };

    template <typename T>
    constexpr bool is_void_cond_s_v{is_void_cond_s<T>::value};

std::conditionalの値パラメータis_void_f<T>()は、「is_void_fの実装」で示したものである。 この例では、SFINAEもクラステンプレートの特殊化も使用していないが、 下記単体テストからわかる通り、「is_void_sfinae_sの実装」と同じ機能を備えている。

    //  example/template/is_void_ut.cpp 288

    static_assert(!is_void_cond_s_v<int>);
    static_assert(std::is_base_of_v<std::false_type, is_void_cond_s<int>>);

    static_assert(!is_void_cond_s_v<std::string>);
    static_assert(std::is_base_of_v<std::false_type, is_void_cond_s<std::string>>);

    static_assert(is_void_cond_s_v<void>);
    static_assert(std::is_base_of_v<std::true_type, is_void_cond_s<void>>);

is_same_xxxの実装

ここではstd::is_same<T, U>に似た、 以下のような仕様を持ついくつかのテンプレートis_same_xxxの実装を考える。

テンプレートパラメータ 戻り値
T == U true
T != U false

それぞれのis_same_xxxは下記テーブルで示された言語機能を使用して実装する。

is_same_xxx 実装方法
is_same_f 関数テンプレートのオーバーロード
is_same_v 定数テンプレートの特殊化
is_same_s クラステンプレートの特殊化
is_same_sfinae_f SFINAEと関数テンプレート/関数のオーバーロード
is_same_sfinae_s SFINAEとクラステンプレートの特殊化
same_as コンセプトよるis_same_sfinae_sと同一の機能
is_same_templ テンプレートテンプレートパラメータ
IsSameSomeOf パラメータパックと再帰
OneOf IsSameSomeOfをコンセプトに

is_same_f

関数テンプレートのオーバーロードを用いたis_same_fの実装は以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 9

    template <typename T, typename U>
    constexpr bool is_same_f_helper(T const*, U const*) noexcept
    {
        return false;
    }

    template <typename T>
    constexpr bool is_same_f_helper(T const*, T const*) noexcept
    {
        return true;
    }

    template <typename T, typename U>
    constexpr bool is_same_f() noexcept
    {
        return is_same_f_helper(static_cast<T*>(nullptr), static_cast<U*>(nullptr));
    }

    template <typename T, typename U>
    constexpr bool is_same_f_v{is_same_f<T, U>()};

すでに述べたように関数テンプレートの部分特殊化は言語仕様として認められておらず、

    //  example/template_cpp17/is_same_ut.cpp 34

    template <typename T, typename U>
    constexpr bool is_same_f()
    {
        return true;
    }

    template <typename T>
    constexpr bool is_same_f<T, T>()
    {
        return true;
    }

上記のようなのようなコードは、以下のようなコンパイルエラーになる (g++/clang++のような優れたコンパイラを使えば、 以下のメッセージのように簡単に問題点が理解できることもある)。

    is_same_ut.cpp:35:32: error: non-class, non-variable partial specialization ‘
                                          is_same_f<T, T>’ is not allowed
        35 | constexpr bool is_same_f<T, T>()

関数テンプレートは部分特殊化が出来ない代わりに、 同じ識別子を持つ関数や関数テンプレートとのオーバーロードができる。関数とのオーバーロードの場合、 is_same_f_helper<T>()のようなテンプレートパラメータを直接使用した静的ディスパッチが出来ないため、 常に型推測によるディスパッチが必要になる。

単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 52

    static_assert(!is_same_f_v<int, void>);
    static_assert(is_same_f_v<int, int>);
    static_assert(!is_same_f_v<int, uint32_t>);
    static_assert(is_same_f_v<std::string, std::basic_string<char>>);

is_same_v

定数テンプレートの特殊化を用いたis_same_vの実装は以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 61

    template <typename T, typename U>
    constexpr bool is_same_v{false};

    template <typename T>
    constexpr bool is_same_v<T, T>{true};

単純であるため、解説は不要だろう。 単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 72

    static_assert(!is_same_v<int, void>);
    static_assert(is_same_v<int, int>);
    static_assert(!is_same_v<int, uint32_t>);
    static_assert(is_same_v<std::string, std::basic_string<char>>);

is_same_s

クラステンプレートの特殊化を用いたis_same_sの実装は以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 81

    template <class T, class U>
    struct is_same_s : std::false_type {
    };

    template <class T>
    struct is_same_s<T, T> : std::true_type {
    };

    template <typename T, typename U>
    constexpr bool is_same_s_v{is_same_s<T, U>::value};

is_same_vの実装」と同様に単純であるため、解説は不要だろう。 単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 97

    static_assert(!is_same_s_v<int, void>);
    static_assert(is_same_s_v<int, int>);
    static_assert(!is_same_s_v<int, uint32_t>);
    static_assert(is_same_s_v<std::string, std::basic_string<char>>);

is_same_sfinae_f

SFINAEと関数テンプレート/関数のオーバーロードを用いたis_same_sfinae_f実装は以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 106

    namespace Inner_ {
    template <typename T, typename U>
    constexpr auto is_same_sfinae_f_detector(T const* t, U const* u) noexcept
        -> decltype(t = u, u = t, bool{})  // T != Uの場合、t = u, u = tはill-formed
                                           // T == Uの場合、well-formedでbool型生成
    {
        return true;
    }

    constexpr bool is_same_sfinae_f_detector(...) noexcept { return false; }
    }  // namespace Inner_

    template <typename T, typename U>
    constexpr bool is_same_sfinae_f() noexcept
    {
        return Inner_::is_same_sfinae_f_detector(static_cast<T*>(nullptr), static_cast<U*>(nullptr));
    }

    template <typename T, typename U>
    constexpr bool is_same_sfinae_f_v{is_same_sfinae_f<T, U>()};

上記の抜粋である下記コードのコメントで示したように、

    //  example/template_cpp17/is_same_ut.cpp 112

    -> decltype(t = u, u = t, bool{})  // T != Uの場合、t = u, u = tはill-formed
                                       // T == Uの場合、well-formedでbool型生成

T != Uの場合、この関数テンプレートはill-formedとなりname lookupの対象ではなくなる。 その結果、関数is_same_sfinae_f_detectorが選択される。 省略記号”…“(ellipsis)を引数とする関数は、そのオーバーロード群の中での最後の選択となるため、 T == Uの場合は、関数テンプレートis_same_sfinae_f_detectorが選択される。

単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 136

    static_assert(!is_same_sfinae_f_v<int, void>);
    static_assert(is_same_sfinae_f_v<int, int>);
    static_assert(!is_same_sfinae_f_v<int, uint32_t>);
    static_assert(is_same_sfinae_f_v<std::string, std::basic_string<char>>);

is_same_sfinae_s

SFINAEとクラステンプレートの特殊化を用いたis_same_sfinae_sの実装は以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 144

    namespace Inner_ {
    template <typename T>
    T*& t2ptr();
    }

    template <typename T, typename U, typename = T*&>
    struct is_same_sfinae_s : std::false_type {
    };

    template <typename T, typename U>
    struct is_same_sfinae_s<
        T, U,

        // T != Uの場合、ill-formed
        // T == Uの場合、well-formedでT*&生成
        decltype(Inner_::t2ptr<T>() = Inner_::t2ptr<U>(), Inner_::t2ptr<U>() = Inner_::t2ptr<T>())
        > : std::true_type {
    };

    template <typename T, typename U>
    constexpr bool is_same_sfinae_s_v{is_same_sfinae_s<T, U>::value};

is_void_sfinae_sの実装」とほぼ同様であるため、解説は不要だろう。 単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 172

    static_assert(!is_same_sfinae_s_v<int, void>);
    static_assert(is_same_sfinae_s_v<int, int>);
    static_assert(!is_same_sfinae_s_v<int, uint32_t>);
    static_assert(is_same_sfinae_s_v<std::string, std::basic_string<char>>);

same_as

SFINAEによるis_same_sfinae_sの難解なコードをコンセプト よりリファクタリングしたコードを以下に示す。

    //  example/template_cpp17/is_same_ut.cpp 181

    #if __cplusplus >= 202002L  // c++20
    template <typename T, typename U>
    concept same_as = requires(T const* t, U const* u)
    {
        {t = u, u = t};
    };

    #else  // c++17
    template <typename T, typename U>
    inline constexpr bool same_as = is_same_sfinae_s_v<T, U>;

    #endif

is_same_sfinae_sは定数テンプレートであり、same_asはコンセプトであるが、 下記のテストから明らかな通り、ほぼ同様に同様に使用することができる。

    //  example/template_cpp17/is_same_ut.cpp 196

    static_assert(!same_as<int, void>);
    static_assert(same_as<int, int>);
    static_assert(!same_as<int, uint32_t>);
    static_assert(same_as<std::string, std::basic_string<char>>);

is_same_s」で紹介した特殊化のテクニックを下記のように使用することができる。

    //  example/template_cpp17/is_same_ut.cpp 203

    #if __cplusplus >= 202002L  // c++20
    template <typename T, typename U>
    struct is_same_concept_s : std::false_type {
    };

    template <typename T, typename U>
    requires same_as<T, U>
    struct is_same_concept_s<T, U> : std::true_type {
    };

    #else  // c++17
    template <typename T, typename U, typename = void>
    struct is_same_concept_s : std::false_type {
    };

    template <typename T, typename U>
    struct is_same_concept_s<T, U, std::enable_if_t<same_as<T, U>, void>> : std::true_type {
    };

    #endif

    static_assert(!is_same_concept_s<int, void>::value);
    static_assert(is_same_concept_s<int, int>::value);
    static_assert(!is_same_concept_s<int, uint32_t>::value);
    static_assert(is_same_concept_s<std::string, std::basic_string<char>>::value);

is_same_templ

例えば、std::stringとstd::basic_string<T>が同じもしくは違う型であることを確認するためには、 すでに示したis_same_sを使用し、

    //  example/template_cpp17/is_same_ut.cpp 246

    static_assert(is_same_s_v<std::string, std::basic_string<char>>);
    static_assert(!is_same_s_v<std::string, std::basic_string<signed char>>);

のようにすればよいが、 以下に示したコードのようにテンプレートテンプレートパラメータを使うことでも実装できる。

    //  example/template_cpp17/is_same_ut.cpp 234

    template <typename T, template <class...> class TEMPL, typename... ARGS>
    struct is_same_templ : is_same_sfinae_s<T, TEMPL<ARGS...>> {
    };

    template <typename T, template <class...> class TEMPL, typename... ARGS>
    constexpr bool is_same_templ_v{is_same_templ<T, TEMPL, ARGS...>::value};

上記のis_same_templは、第2引数にクラステンプレート、 第3引数以降にそのクラステンプレートの1個以上の引数を取ることができる。 使用例を兼ねた単体テストは以下のようになる。

    //  example/template_cpp17/is_same_ut.cpp 251

    static_assert(is_same_templ_v<std::string, std::basic_string, char>);
    static_assert(!is_same_templ_v<std::string, std::basic_string, signed char>);

これを応用したエイリアステンプレート

    //  example/template_cpp17/is_same_ut.cpp 258

    template <typename T>
    using gen_std_string = is_same_templ<std::string, std::basic_string, T>;

    template <typename T>
    constexpr bool gen_std_string_v{gen_std_string<T>::value};

は与えられたテンプレートパラメータがstd::stringを生成するかどうかを判定することができる。

    //  example/template_cpp17/is_same_ut.cpp 269

    static_assert(gen_std_string_v<char>);
    static_assert(!gen_std_string_v<signed char>);

IsSameSomeOf

IsSameSomeOfはこれまでの例とは少々異なり、

のような特徴のを持つ。 このようなIsSameSomeOfの実装はは以下のようになる。

    //  example/h/nstd_type_traits.h 13

    namespace Nstd {
    namespace Inner_ {
    template <typename T, typename U, typename... Us>
    struct is_same_as_some_of_impl {  // 型特性の補助クラス: 複数の型と比較する再帰的な実装
        static constexpr bool value = std::is_same<T, U>::value || is_same_as_some_of_impl<T, Us...>::value;
    };

    // 再帰の終端条件: 比較する型が1つの場合
    template <typename T, typename U>
    struct is_same_as_some_of_impl<T, U> {
        static constexpr bool value = std::is_same<T, U>::value;
    };
    }  // namespace Inner_

    #if __cplusplus >= 202002L  // c++20
    // コンセプト: 複数の型のいずれかがTと同じかどうかをチェック
    template <typename T, typename U, typename... Us>
    concept SameAsSomeOf = (std::same_as<T, U> || (std::same_as<T, Us> || ...));

    #else  // c++17
    // コンセプトが使えない場合、上と同じ機能を持つ変数テンプレート
    template <typename T, typename U, typename... Us>
    constexpr bool SameAsSomeOf = Inner_::is_same_as_some_of_impl<T, U, Us...>::value;
    #endif

    // 型特性: TがUsのいずれかと同じ場合true_type、そうでない場合false_typeを継承
    template <typename T, typename U, typename... Us>
    struct IsSameSomeOf : std::bool_constant<SameAsSomeOf<T, U, Us...>> {
    };

    // 便利な定数テンプレート
    template <typename T, typename U, typename... Us>
    constexpr bool IsSameSomeOfV = IsSameSomeOf<T, U, Us...>::value;
    }  // namespace Nstd

IsSameSomeOfは、TがUsのいずれかと一致するかどうかのほとんどの処理をSameAsSomeOfに移譲する。

Usが1つだった場合、SameAsSomeOfは処理をstd::same_as(「same_as」参照)に委譲する。 Usが複数だった場合、畳み込み式を使用し上記の処理をその数分、繰り返す。

単体テストは以下のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 14

    static_assert(!Nstd::IsSameSomeOfV<int, int8_t, int16_t, uint16_t>);
    static_assert(Nstd::IsSameSomeOfV<int, int8_t, int16_t, uint16_t, int32_t>);
    static_assert(Nstd::IsSameSomeOfV<int&, int8_t, int16_t, int32_t&, int32_t>);
    static_assert(!Nstd::IsSameSomeOfV<int&, int8_t, int16_t, uint32_t&, int32_t>);
    static_assert(Nstd::IsSameSomeOfV<std::string, int, char*, std::string>);
    static_assert(!Nstd::IsSameSomeOfV<std::string, int, char*>);

OneOf

OneOfは、IsSameSomeOf同様の機能を持つコンセプトである。 OneOfの実装にはシンプルに記述するための畳み込み式を使用した。

    //  h/nstd_concepts.h 52

    template <typename T, typename... Us>
    concept OneOf = (std::same_as<T, Us> || ...);

単体テストは以下のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 29

    static_assert(!Nstd::OneOf<int, int8_t, int16_t, uint16_t>);
    static_assert(Nstd::OneOf<int, int8_t, int16_t, uint16_t, int32_t>);
    static_assert(Nstd::OneOf<int&, int8_t, int16_t, int32_t&, int32_t>);
    static_assert(!Nstd::OneOf<int&, int8_t, int16_t, uint32_t&, int32_t>);
    static_assert(Nstd::OneOf<std::string, int, char*, std::string>);
    static_assert(!Nstd::OneOf<std::string, int, char*>);

AreConvertibleXxxの実装

std::is_convertible<FROM, TO>は、

のような仕様を持つテンプレートである。

ここでは、

の実装を考える。

AreConvertibleXxx 実装方法
AreConvertible クラステンプレートの特殊化
ConvertibleToAll AreConvertibleをコンセプトへ
AreConvertibleWithoutNarrowConv SFINAEとクラステンプレートの特殊化
ConvertibleWithoutNarrowing AreConvertibleWithoutNarrowConvをコンセプトへ

AreConvertible

AreConvertibleの実装は以下のようになる。

    //  example/h/nstd_type_traits.h 53

    namespace Nstd {
    namespace Inner_ {

    template <typename TO, typename FROM, typename... FROMs>
    struct are_convertible {
        static constexpr bool value{std::is_convertible_v<FROM, TO> && are_convertible<TO, FROMs...>::value};
    };

    template <typename TO, typename FROM>
    struct are_convertible<TO, FROM> {
        static constexpr bool value{std::is_convertible_v<FROM, TO>};
    };

    template <typename TO, typename... FROMs>
    constexpr bool are_convertible_v{are_convertible<TO, FROMs...>::value};
    }  // namespace Inner_

    template <typename TO, typename... FROMs>
    struct AreConvertible : std::conditional_t<Inner_::are_convertible_v<TO, FROMs...>, std::true_type, std::false_type> {
    };

    template <typename TO, typename... FROMs>
    constexpr bool AreConvertibleV{AreConvertible<TO, FROMs...>::value};
    }  // namespace Nstd

IsSameSomeOfの実装」のコードパターンとほぼ同様であるため、解説は不要だろうが、

ので注意が必要である。

単体テストは以下のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 43

    static_assert(Nstd::AreConvertibleV<int, int8_t, int16_t, int>);
    static_assert(Nstd::AreConvertibleV<int, char, int, int>);
    static_assert(!Nstd::AreConvertibleV<int, char*, int, int>);
    static_assert(Nstd::AreConvertibleV<std::string, std::string, char*, char[3]>);
    static_assert(!Nstd::AreConvertibleV<std::string, std::string, char*, int>);

AreConvertibleWithoutNarrowConv

縮小無しの型変換ができるかどうかを判定するAreConvertibleWithoutNarrowConvは、 AreConvertibleと同じように実装できるが、 その場合、AreConvertibleに対してstd::is_convertibleが必要になったように、 AreConvertibleWithoutNarrowConvに対しis_convertible_without_narrow_convが必要になる。

縮小無しでFROMからTOへの型変換ができるかどうかを判定するis_convertible_without_narrow_convは、 SFINAEと関数テンプレート/関数のオーバーライドを使用し以下のように実装できる。

    //  example/h/nstd_type_traits.h 85

    namespace Nstd {
    namespace Inner_ {

    template <typename TO, typename FROM>
    class is_convertible_without_narrow_conv {
        template <typename T = TO, typename U = FROM>
        static constexpr auto detector(T* t, U* u) noexcept
            // 縮小無しでFROMからTOへ変換可能な場合、*t = T{*u}はwell-formed
            // 上記ではない場合、*t = T{*u}はill-formed
            -> decltype(*t = T{*u}, bool{})
        {
            return true;
        }

        static constexpr bool detector(...) noexcept { return false; }

    public:
        static constexpr bool value{
            is_convertible_without_narrow_conv::detector(static_cast<TO*>(nullptr), static_cast<FROM*>(nullptr))};
    };

    template <typename TO, typename FROM>
    constexpr bool is_convertible_without_narrow_conv_v{is_convertible_without_narrow_conv<TO, FROM>::value};
    }  // namespace Inner_
    }  // namespace Nstd

AreConvertibleWithoutNarrowConvはNstdで定義するため、その内部のみで用いる is_convertible_without_narrow_convはNstd::Inner_で定義している。

上記を抜粋した下記のコードは「縮小型変換を発生さる{}による初期化はill-formedになる」 ことをSFINAEに利用している。

    //  example/h/nstd_type_traits.h 95

    // 縮小無しでFROMからTOへ変換可能な場合、*t = T{*u}はwell-formed
    // 上記ではない場合、*t = T{*u}はill-formed
    -> decltype(*t = T{*u}, bool{})

単体テストは以下のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 55

    static_assert(Nstd::Inner_::is_convertible_without_narrow_conv_v<int, int>);
    static_assert(Nstd::Inner_::is_convertible_without_narrow_conv_v<int, int16_t>);
    static_assert(!Nstd::Inner_::is_convertible_without_narrow_conv_v<int16_t, int>);
    static_assert(Nstd::Inner_::is_convertible_without_narrow_conv_v<std::string, char*>);
    static_assert(!Nstd::Inner_::is_convertible_without_narrow_conv_v<char*, std::string>);

is_convertible_without_narrow_convを利用したAreConvertibleWithoutNarrowConv の実装は以下のようになる。

    //  example/h/nstd_type_traits.h 117

    namespace Nstd {
    namespace Inner_ {

    template <typename TO, typename FROM, typename... FROMs>
    struct are_convertible_without_narrow_conv {
        static constexpr bool value{
            is_convertible_without_narrow_conv_v<TO, FROM> 
                  && are_convertible_without_narrow_conv<TO, FROMs...>::value};
    };

    template <typename TO, typename FROM>
    struct are_convertible_without_narrow_conv<TO, FROM> {
        static constexpr bool value{is_convertible_without_narrow_conv_v<TO, FROM>};
    };

    template <typename TO, typename FROM, typename... FROMs>
    constexpr bool are_convertible_without_narrow_conv_v{are_convertible_without_narrow_conv<TO, FROM, FROMs...>::value};
    }  // namespace Inner_

    template <typename TO, typename FROM, typename... FROMs>
    struct AreConvertibleWithoutNarrowConv
        : std::conditional_t<Inner_::are_convertible_without_narrow_conv_v<TO, FROM, FROMs...>, std::true_type,
                             std::false_type> {
    };

    template <typename TO, typename FROM, typename... FROMs>
    constexpr bool AreConvertibleWithoutNarrowConvV{AreConvertibleWithoutNarrowConv<TO, FROM, FROMs...>::value};
    }  // namespace Nstd

単体テストは以下のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 63

    static_assert(Nstd::AreConvertibleWithoutNarrowConvV<int, char, int16_t, uint16_t>);
    static_assert(!Nstd::AreConvertibleWithoutNarrowConvV<int, char, int16_t, uint32_t>);
    static_assert(Nstd::AreConvertibleWithoutNarrowConvV<std::string, char[5], char*>);
    static_assert(Nstd::AreConvertibleWithoutNarrowConvV<double, float>);

    // int8_t -> doubleは縮小型変換
    static_assert(!Nstd::AreConvertibleWithoutNarrowConvV<double, float, int8_t>);

ConvertibleToAll

ConvertibleToAllの実装は下記のようになる。

    //  h/nstd_concepts.h 57

// 複数の型 FROMs がすべて TO に変換可能かどうかを制約するコンセプト
template <typename TO, typename... FROMs>
concept ConvertibleToAll = (std::convertible_to<FROMs, TO> && ...);

使用方法を含めて、単体テストは以下のようになる。

    //  example/template/nstd_concepts_ut.cpp 137

    // ConvertibleToAll_Test テンプレートの定義
    template <typename TO, typename... FROMs>
    struct ConvertibleToAll_Test : std::false_type {
    };

    // すべての FROMs が TO に変換可能な場合の部分特殊化
    template <typename TO, typename... Us>
    requires ConvertibleToAll<TO, Us...>
    struct ConvertibleToAll_Test<TO, Us...> : std::true_type {
    };

    struct convert_bool {
        operator bool() const { return false; }
    };

    static_assert(!ConvertibleToAll_Test<bool, int, std::string>::value);
    static_assert(ConvertibleToAll_Test<bool, int, convert_bool>::value);

ConvertibleWithoutNarrowing

ConvertibleWithoutNarrowingは以下のようなコンセプトである。

実装は以下のようになる。

    //  h/nstd_concepts.h 63

namespace Inner_ {

template <typename TO, typename FROM>
concept convertible_without_narrowing = requires(FROM from)
{
    { TO {from} } -> std::same_as<TO>;
};

// 複数の型が変換可能かどうかを確認するバージョン
template <typename TO, typename... FROMs>
concept all_convertible_without_narrowing = (convertible_without_narrowing<TO, FROMs> && ...);

}  // namespace Inner_

// コンセプトを使用
template <typename TO, typename... FROMs>
concept ConvertibleWithoutNarrowing = Inner_::all_convertible_without_narrowing<TO, FROMs...>;

単体テストは他の似たコンセプトとほぼ同様になるため省略する。

関数の存在の診断

Nstdライブラリの開発には関数の存在の診断が欠かせない。 例えば、

等、応用範囲は多岐にわたる。 ここでは、上記の場合分けを可能とするようなメタ関数に必要なテクニックや、 それらを使用したNstdのメタ関数の実装を下記のように示す。

メタ関数名 メタ関数の目的
exists_void_func_sfinae_f メンバ関数void func()を持つかどうかの判断
exists_void_func_sfinae_s 同上
exists_void_func_sfinae_s2 同上
exists_void_func_concept 同上。コンセプトによるSFINAEの回避
メタ関数名 メタ関数の目的
exists_begin/exsits_end SFINAEを使用したstd::begin(T)/std::end(T)が存在するか否かの診断
Array 型が配列である制約を行うためのコンセプト
Beginable/Endable コンセプトを使用したexists_begin/exsits_endを単純化した例
IsRange exists_begin/exsits_endを使し、範囲forのオペランドになれるか?の判断
Ranged 機能はIsRangeと同一だが、コンセプトを使用しSFINAEの回避
Container Ranged且つ!Arrayをコンテナと便宜的に決めつける
メタ関数名 メタ関数の目的
exists_put_to_as_member std::ostream::operator<<(T)が存在するか否かの診断
exists_put_to_as_non_member operator<<(std::ostream&, T)が存在するか否かの診断
ExistsPutTo std::ostream& << Tができるかどうかの診断
Printable std::ostream& << Tができるかどうか制約コンセプト

exists_void_func_sfinae_f

「テンプレートパラメータである型が、メンバ関数void func()を持つかどうかを診断する」 exists_void_func_sfinae_f のSFINAEと関数テンプレート/関数のオーバーロードを用いた実装は以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 13

    namespace Inner_ {

    template <typename T>
    using exists_void_func_void =
        // メンバvoid func(void)があれば、voidを生成
        // メンバvoid func(void)がなければ、ill-formed
        typename std::enable_if_t<std::is_same_v<decltype(std::declval<T>().func()), void>>;
    }  // namespace Inner_

    template <typename T, typename = Inner_::exists_void_func_void<T>>
    constexpr bool exists_void_func_sfinae_f(T) noexcept
    {
        return true;
    }

    constexpr bool exists_void_func_sfinae_f(...) noexcept { return false; }

decltypeの中での関数呼び出しは、実際には呼び出されず関数の戻り値の型になる。 上記の抜粋である下記のコードはこの性質を利用してSFINAEによる静的ディスパッチを行っている。

    //  example/template_cpp17/exists_func_ut.cpp 20

    // メンバvoid func(void)があれば、voidを生成
    // メンバvoid func(void)がなければ、ill-formed
    typename std::enable_if_t<std::is_same_v<decltype(std::declval<T>().func()), void>>;

単体テストは以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 40

    // テスト用クラス
    struct X {
        void func();
    };

    struct Y {
        int func();
    };

    struct Z {
    private:
        void func();  // privateなvoid func()は外部からは呼び出せない
    };
    //  example/template_cpp17/exists_func_ut.cpp 60

    static_assert(!exists_void_func_sfinae_f(int{}));
    static_assert(exists_void_func_sfinae_f(X{}));
    static_assert(!exists_void_func_sfinae_f(Y{}));
    static_assert(!exists_void_func_sfinae_f(Z{}));

exists_void_func_sfinae_s

「テンプレートパラメータである型が、メンバ関数void func()を持つかどうかを診断」する exists_void_func_sfinae_s のSFINAEとクラステンプレートの特殊化を用いた実装は以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 69

    template <typename T, typename U = void>
    struct exists_void_func_sfinae_s : std::false_type {
    };

    template <typename T>
    struct exists_void_func_sfinae_s<T,
        // メンバvoid func()が呼び出せれば、voidを生成
        // メンバvoid func()が呼び出せなければ、ill-formed
        decltype(std::declval<T>().func())
        > : std::true_type {
    };

    template <typename T>
    constexpr bool exists_void_func_sfinae_s_v{exists_void_func_sfinae_s<T>::value};

exists_void_func_sfinae_fとほぼ等しいSFINAEを利用したクラステンプレートの特殊化により、 静的ディスパッチを行っている。

単体テストは以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 91

    static_assert(!exists_void_func_sfinae_s_v<int>);
    static_assert(exists_void_func_sfinae_s_v<X>);
    static_assert(!exists_void_func_sfinae_s_v<Y>);
    static_assert(!exists_void_func_sfinae_s_v<Z>);

exists_void_func_sfinae_s2

exists_void_func_sfinae_sとほぼ同様の仕様を持つexists_void_func_sfinae_s2の

を用いた実装は以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 100

    template <typename T>
    class exists_void_func_sfinae_s2 {

        // メンバvoid func()が呼び出せれば、メンバ関数テンプレートはtrueを返す
        // メンバvoid func()が呼び出せなければ、ill-formed
        template <typename U, void (U::*)() = &U::func>
        static constexpr bool detector(U*) noexcept
        {
            return true;
        }

        static constexpr bool detector(...) noexcept { return false; }

    public:
        static constexpr bool value{exists_void_func_sfinae_s2::detector(static_cast<T*>(nullptr))};
    };

    template <typename T>
    constexpr bool exists_void_func_sfinae_s2_v{exists_void_func_sfinae_s2<T>::value};

前2例とは異なり、上記の抜粋である下記コードのように、 メンバ関数へのポインタを使用しSFINAEを実装している。

    //  example/template_cpp17/exists_func_ut.cpp 105

    // メンバvoid func()が呼び出せれば、メンバ関数テンプレートはtrueを返す
    // メンバvoid func()が呼び出せなければ、ill-formed
    template <typename U, void (U::*)() = &U::func>
    static constexpr bool detector(U*) noexcept
    {
        return true;
    }

あまり応用範囲が広くない方法ではあるが、 decltypeを使っていないのでC++03コンパイラにも受け入れられるメリットがある。

exists_void_func_sfinae_fと同じテスト用クラスを用いた単体テストは以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 129

    static_assert(!exists_void_func_sfinae_s2_v<int>);
    static_assert(exists_void_func_sfinae_s2_v<X>);
    static_assert(!exists_void_func_sfinae_s2_v<Y>);
    static_assert(!exists_void_func_sfinae_s2_v<Z>);

exists_void_func_concept

exists_void_func_sfinae_sexists_void_func_sfinae_s2 の実装で見たようなSFINAEによるテンプレートの特殊化は難解なコードを生み出す。 また、シンタックスエラー時、ほぼ理解できない大量のコンパイラのメッセージを生成する。 このため、このようなテクニックはきわめて有用である一方で、開発に多くの時間を消費する、 保守員を選んでしまう、といった問題があった。 以下に示すように、C++20から導入されたコンセプトはこのような問題の軽減につながる。

    //  example/template_cpp17/exists_func_ut.cpp 138

    #if __cplusplus >= 202002L  // c++20
    template <typename T>  // C++20スタイル。concept/requiresによるSFINAEの回避
    concept exists_void_func_concept = requires(T& t)
    {
        { t.func() } -> std::same_as<void>;
    };

    #else  // c++17
    namespace Inner_ {
    template <typename T, typename = void>
    struct exists_void_func_impl : std::false_type {
    };

    template <typename T>  // C++17スタイル。SFINAEでの実装
    struct exists_void_func_impl<T,
                                 std::void_t<decltype(std::declval<T&>().func())>>  // func()が呼び出し可能か確認
        : std::is_same<void, decltype(std::declval<T&>().func())>                   // 戻り値がvoidか確認
    {
    };
    }  // namespace Inner_

    template <typename T>
    inline constexpr bool exists_void_func_concept = Inner_::exists_void_func_impl<T>::value;
    #endif
    //  example/template_cpp17/exists_func_ut.cpp 170
    static_assert(!exists_void_func_concept<decltype(int{})>);
    static_assert(exists_void_func_concept<decltype(X{})>);
    static_assert(!exists_void_func_concept<decltype(Y{})>);  // Y::funcの戻りはint
    static_assert(!exists_void_func_concept<decltype(Z{})>);  // Z::funcは呼び出せない

exists_begin/exsits_end

「テンプレートパラメータTに対して、 std::begin(T)が存在するか否かの診断」をするexists_beginの実装は、 「exists_void_func_sfinae_s」 で用いたパターンのメンバ関数を非メンバ関数に置き換えて使えば以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 180

    template <typename, typename = void>
    struct exists_begin : std::false_type {
    };

    template <typename T>
    struct exists_begin<T, std::void_t<decltype(std::begin(std::declval<T>()))>> : std::true_type {
    };

    template <typename T>
    constexpr bool exists_begin_v{exists_begin<T>::value};

上記で使用したstd::void_tは、テンプレートパラメータが

テンプレートである。

下記単体テストでは問題ないように見えるが、

    //  example/template_cpp17/exists_func_ut.cpp 196

    static_assert(exists_begin_v<std::string>);
    static_assert(!exists_begin_v<int>);
    static_assert(exists_begin_v<int const[3]>);

下記の単体テストはstatic_assertがフェールするためコンパイルできない。

    //  example/template_cpp17/exists_func_ut.cpp 206

    // 以下が問題
    static_assert(exists_begin_v<int[3]>);

理由は、

    std::declval<int[3]>())

の戻り型が配列型のrvalueである”int (&&) [3]“となり、 これに対応するstd::beginが定義されていないためである。

これに対処する方法方はいくつかあるが、 すべての配列は常にstd::beginの引数になれることに気づけば、 テンプレートパラメータが配列か否かで場合分けしたクラステンプレートの特殊化を使い、 下記のように実装できることにも気付けるだろう。

    //  example/template_cpp17/exists_func_ut.cpp 223

    template <typename, typename = void>
    struct exists_begin : std::false_type {
    };

    // Tが非配列の場合の特殊化
    template <typename T>
    struct exists_begin<
        T, typename std::enable_if_t<!std::is_array_v<T>, std::void_t<decltype(std::begin(std::declval<T>()))>>>
        : std::true_type {
    };

    // Tが配列の場合の特殊化
    template <typename T>
    struct exists_begin<T, typename std::enable_if_t<std::is_array_v<T>>> : std::true_type {
    };

    template <typename T>
    constexpr bool exists_begin_v{exists_begin<T>::value};

2個目のexists_beginはTが配列でない場合、 3個目のexists_beginはTが配列ある場合にそれぞれが対応しているが、複雑すぎて何とも醜い。 ということで、このコードは却下して、別のアイデアを試そう。

テンプレートパラメータが配列である場合でも、 そのオブジェクトがlvalue(この例ではint (&)[3])であれば、 std::beginはそのオブジェクトを使用できるので、 decltype内で使用できるlvalueのT型オブジェクトを生成できれば、 と考えれば下記のような実装を思いつくだろう。

    //  example/h/nstd_type_traits.h 158

    template <typename, typename = void>
    struct exists_begin : std::false_type {
    };

    template <typename T>
    struct exists_begin<T, std::void_t<decltype(std::begin(std::declval<T&>()))>> : std::true_type {
    };

    template <typename T>
    constexpr bool exists_begin_v{exists_begin<T>::value};

十分にシンプルなのでこれを採用し、exists_endも同様に実装する。

    //  example/h/nstd_type_traits.h 171

    template <typename, typename = void>
    struct exists_end : std::false_type {
    };

    template <typename T>
    struct exists_end<T, std::void_t<decltype(std::end(std::declval<T&>()))>> : std::true_type {
    };
    template <typename T>
    constexpr bool exists_end_v{exists_end<T>::value};

単体テストは下記のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 97

    static_assert(exists_begin_v<std::string>);
    static_assert(!exists_begin_v<int>);
    static_assert(exists_begin_v<int const[3]>);
    static_assert(exists_begin_v<int[3]>);  // 問題が解決

    static_assert(exists_end_v<std::string>);
    static_assert(!exists_end_v<int>);
    static_assert(exists_end_v<int const[3]>);
    static_assert(exists_end_v<int[3]>);

IsRange

範囲for文 文の”:“の後ろにT型オブジェクトが指定できる要件は、

ようなことである。多くの要件はセマンティクス的なものであり、 メタ関数で診断できることは前項で見たようなstd::begin(T)、std::end(T)の可否のみであると考えれば、 IsRangeの実装は以下のようになる。

    //  example/h/nstd_type_traits.h 185

    template <typename T>
    struct IsRange
        : std::conditional_t<Inner_::exists_begin_v<T> && Inner_::exists_end_v<T>, std::true_type, std::false_type> {
    };

    template <typename T>
    constexpr bool IsRangeV{IsRange<T>::value};

なお、上記のコードでは、exists_begin/exsits_endは、IsRangeの実装の詳細であるため、 名前空間Inner_で宣言している。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 116

    static_assert(IsRangeV<std::string>);
    static_assert(!IsRangeV<int>);
    static_assert(IsRangeV<int const[3]>);
    static_assert(IsRangeV<int[3]>);

Array

以降の節で使用するため、テンプレートパラメータが配列である制約を下記のように宣言する。

    //  h/nstd_concepts.h 9

    template <typename T>
    concept Array = std::is_array_v<T>;
    //  example/template/nstd_concepts_ut.cpp 18

    int  a[3];
    int* ptr = a;
    auto v   = std::vector{1, 2, 3};

    static_assert(Array<decltype(a)>);

    static_assert(Array<decltype(a)>);
    static_assert(!Array<decltype(ptr)>);

Beginable/Endable

コンセプトを使用し、exists_begin/exsits_endをリファクタリングした例を以下に示す。

    //  h/nstd_concepts.h 15

    template <typename T>
    concept Beginable = Array<T> || requires(T& t)
    {
        { std::begin(t) } -> std::same_as<typename T::iterator>;
    };

    template <typename T>
    concept Endable = Array<T> || requires(T& t)
    {
        { std::end(t) } -> std::same_as<typename T::iterator>;
    };
    //  example/template/nstd_concepts_ut.cpp 34

    int  a[3];
    int* ptr = a;
    auto v   = std::vector{1, 2, 3};

    static_assert(Array<decltype(a)>);

    static_assert(Beginable<decltype(a)>);
    static_assert(!Beginable<decltype(ptr)>);
    static_assert(Beginable<decltype(v)>);

Ranged

IsRangeと同一の機能を持つコンセプトRangedを以下のように定義する。

    //  h/nstd_concepts.h 33

    template <typename T>
    concept Ranged = Beginable<T> && Endable<T>;

単体テストは以下のようになる。

    //  example/template/nstd_concepts_ut.cpp 53

    static_assert(Ranged<std::string>);
    static_assert(!Ranged<int>);
    static_assert(Ranged<int const[3]>);
    static_assert(Ranged<int[3]>);

すでにみたようにRangedはexists_begin/exsits_endの醜いコードを使用しないことで、 Rangedの可読性はIsRangedに比べ格段に改善している。

Container

与えられた型をコンテナに制約するためのコンセプトを下記のように便宜的に宣言する。

    //  h/nstd_concepts.h 33

    template <typename T>
    concept Ranged = Beginable<T> && Endable<T>;

単体テストには少々の工夫が必要になる。

    //  example/template/nstd_concepts_ut.cpp 62

    struct X {
        std::vector<int> data{1, 2, 3, 4, 5};

        auto begin() { return data.begin(); }  // std::begin
        auto end() { return data.end(); }      // std::end
    };

    //  example/template/nstd_concepts_ut.cpp 74

    static_assert(Container<std::string>);
    static_assert(!Container<int>);
    static_assert(!Container<int const[3]>);

    static_assert(!Ranged<X>);  // begin/endがあるが、value_typeをもっていない

exists_put_to_as_member

std::ostreamのメンバ関数operator<<の戻り型はstd::ostream&であるため、 exists_put_to_as_memberの実装は以下のようになる(“<<”は英語で”put to”と発音する)。

    //  example/template_cpp17/exists_func_ut.cpp 258

    template <typename, typename = std::ostream&>
    struct exists_put_to_as_member : std::false_type {
    };

    template <typename T>
    struct exists_put_to_as_member<T, decltype(std::declval<std::ostream&>().operator<<(std::declval<T>()))>
        : std::true_type {
    };

    template <typename T>
    constexpr bool exists_put_to_as_member_v{exists_put_to_as_member<T>::value};

exists_void_func_sfinae_fの実装」と同様のパターンを使用したので解説は不要だろう。

単体テストは以下のようになる。

    //  example/template/test_class.h 3

    class test_class_exits_put_to {
    public:
        test_class_exits_put_to(int i = 0) noexcept : i_{i} {}
        int get() const noexcept { return i_; }

    private:
        int i_;
    };

    inline std::ostream& operator<<(std::ostream& os, test_class_exits_put_to const& p) { return os << p.get(); }

    class test_class_not_exits_put_to {};
    //  example/template_cpp17/exists_func_ut.cpp 275

    static_assert(exists_put_to_as_member_v<bool>);
    static_assert(!exists_put_to_as_member_v<std::string>);
    static_assert(!exists_put_to_as_member_v<std::vector<int>>);
    static_assert(exists_put_to_as_member_v<std::vector<int>*>);
    static_assert(!exists_put_to_as_member_v<test_class_exits_put_to>);
    static_assert(!exists_put_to_as_member_v<test_class_not_exits_put_to>);
    static_assert(exists_put_to_as_member_v<test_class_not_exits_put_to[3]>);  // 驚き!

やや驚きなのは、上記の抜粋である下記コードがコンパイルできることである。

    //  example/template_cpp17/exists_func_ut.cpp 284

    static_assert(exists_put_to_as_member_v<test_class_not_exits_put_to[3]>);  // 驚き!

これは、

    std::ostream& std::ostream::operator<<(void const*)

が定義されているため、配列がポインタに変換されてこのメンバ関数にバインドした結果である。

exists_put_to_as_non_member

exists_put_to_as_non_memberの実装は以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 293

    template <typename, typename = std::ostream&>
    struct exists_put_to_as_non_member : std::false_type {
    };

    template <typename T>
    struct exists_put_to_as_non_member<T, decltype(operator<<(std::declval<std::ostream&>(), std::declval<T>()))>
        : std::true_type {
    };

    template <typename T>
    constexpr bool exists_put_to_as_non_member_v{exists_put_to_as_non_member<T>::value};

exists_begin/exsits_endexists_put_to_as_memberの実装」 で使用したパターンを混合しただけなので解説や単体テストは省略する。

ExistsPutTo

テンプレートパラメータT、T型オブジェクトtに対して、 std::ostream << tができるかどうかを判断するExistsPutToの実装は以下のようになる。

    //  example/template_cpp17/exists_func_ut.cpp 322

    template <typename T>
    struct ExistsPutTo
        : std::conditional_t<Inner_::exists_put_to_as_member_v<T> || Inner_::exists_put_to_as_non_member_v<T>,
                             std::true_type, std::false_type> {
    };

    template <typename T>
    constexpr bool ExistsPutToV{ExistsPutTo<T>::value};

IsRangeの実装」に影響されて、一旦このように実装したが、先に書いた通り、 そもそものExistsPutToの役割はstd::ostream << tができるかどうかの診断であることを思い出せば、 下記のように、もっとシンプルに実装できることに気づくだろう。

    //  example/h/nstd_type_traits.h 200

    namespace Nstd {

    template <typename, typename = std::ostream&>
    struct ExistsPutTo : std::false_type {
    };

    template <typename T>
    struct ExistsPutTo<T, decltype(std::declval<std::ostream&>() << std::declval<T>())> : std::true_type {
    };

    template <typename T>
    constexpr bool ExistsPutToV{ExistsPutTo<T>::value};
    }  // namespace Nstd

単体テストは下記のようになる。

    //  example/template_cpp17/nstd_type_traits_ut.cpp 127

    static_assert(Nstd::ExistsPutToV<bool>);
    static_assert(Nstd::ExistsPutToV<std::string>);
    static_assert(!Nstd::ExistsPutToV<std::vector<int>>);
    static_assert(Nstd::ExistsPutToV<std::vector<int>*>);
    static_assert(Nstd::ExistsPutToV<test_class_exits_put_to>);
    static_assert(!Nstd::ExistsPutToV<test_class_not_exits_put_to>);
    static_assert(Nstd::ExistsPutToV<test_class_not_exits_put_to[3]>);

Printable

これまでのパターンに従ってPrintableを以下のように作る。

    //  h/nstd_concepts.h 42

    template <typename T>
    concept Printable = requires(T t, std::ostream& os)
    {
        { os << t } -> std::same_as<std::ostream&>;
    };
    //  example/template/nstd_concepts_ut.cpp 86

    struct X {};  // Non-pritable
    struct Y {};  // Printable

    std::ostream& operator<<(std::ostream& os, Y)
    {
        return os;  // 何もしない
    }

    //  example/template/nstd_concepts_ut.cpp 99

    static_assert(Printable<bool>);
    static_assert(Printable<std::string>);
    static_assert(!Printable<std::vector<int>>);
    static_assert(Printable<std::vector<int>*>);
    static_assert(!Printable<X>);
    static_assert(Printable<Y>);

これ以降は、ExistsPutToではなくPrintableを使用する。

ValueTypeの実装

下記で示す通り、

    //  example/template_cpp17/nstd_type_traits_ut.cpp 145

    struct T {};

    std::ostream& operator<<(std::ostream& os, std::vector<T> const& x) { return os << "T:" << x.size(); }

    std::ostream& operator<<(std::ostream&, T const&) = delete;

    static_assert(!Nstd::ExistsPutToV<T>);              // std::cout << T{} はできない
    static_assert(Nstd::ExistsPutToV<std::vector<T>>);  // std::cout << std::vector<T>{} はできる
    static_assert(Nstd::ExistsPutToV<T[3]>);            // std::cout << T[3]{} はできる

型Xが与えれ、その形式が、

のような場合、Printable<X>がtrueであっても、Printable<T>の真偽はわからない。 従って上記のようなTに対して、Printable<T>がtrueかどうかを診断するためには、 XからTを導出することが必要になる。ここでは、そのようなメタ関数ValueTypeの実装を考える。 このValueTypeは上記のX、Tに対して、

    static_assert(std::is_same<ValueType<X>::type, T>);
    // もしくは、
    static_assert(std::is_same<ValueType<X, T>);

となるような機能を持たなければならないことは明らかだろう。 その他の機能については実装しながら決定していく。

一見、難しそうなテンプレートを作るコツは、条件を絞って少しずつ作っていくことである。 いきなり大量のテンプレートを書いてしまうと、 その何十倍ものコンパイルエラーに打ちのめされること必至である。

ということで、まずは、1次元の配列に対してのみ動作するValueTypeの実装を示す (下記で使用するstd::remove_extent_t<T>は、テンプレートパラメータが配列だった場合に、 その次元を一つだけ除去するメタ関数である)。

    //  example/template/value_type_ut.cpp 18

    template <typename T, typename = void>
    struct ValueType {
        using type = void;
    };

    template <typename T, size_t N>
    struct ValueType<T[N]> {  // 配列型の特殊化
        using type = T;
    };

    template <typename T>
    using ValueTypeT = typename ValueType<T>::type;

このコードは問題なく動作するが、下記の通り、2次元配列に対するValueType::typeは1次元配列となる。

    //  example/template/value_type_ut.cpp 36

    static_assert(std::is_same_v<int, ValueTypeT<int[1]>>);
    static_assert(std::is_same_v<void, ValueTypeT<int>>);
    static_assert(std::is_same_v<int[2], ValueTypeT<int[1][2]>>);

これを多次元配列に拡張する前に、配列の次元をで返すValueType::Nestや、extent、type_directを追加することにすると、 コードは下記のようになるだろう。

    //  example/template/value_type_ut.cpp 49

    template <typename T, typename = void>
    struct ValueType {
        using type        = void;
        using type_direct = T;
        static constexpr size_t Nest{0};
    };

    template <typename T, size_t N>
    struct ValueType<T[N]> {  // 配列型の特殊化
        using type                     = T;
        using type_direct              = T;  // T = S[N]の場合、Tを保存
        static constexpr size_t extent = N;  // T = S[N]の場合、Nを保存
        static constexpr size_t Nest{ValueType<type>::Nest + 1};
    };

    template <typename T>
    using ValueTypeT = typename ValueType<T>::type;

動作は下記のようになる。

    //  example/template/value_type_ut.cpp 76

    static_assert(0 == ValueType<int>::Nest);
    static_assert(1 == ValueType<int[1]>::Nest);
    static_assert(2 == ValueType<int[1][2]>::Nest);
    static_assert(1 == ValueType<int[1]>::extent);
    static_assert(1 == ValueType<int[1][2]>::extent);  // int[1][2] == (int[1])[2]

ここで、下記のような仕様をもつValueType::type_n<N>を考える。

    ValueType<int[1][2][3]>::type_n<0>が表す型は、int[1][2][3]
    ValueType<int[1][2][3]>::type_n<1>が表す型は、int[2][3]
    ValueType<int[1][2][3]>::type_n<2>が表す型は、int[3]
    ValueType<int[1][2][3]>::type_n<3>が表す型は、int

ValueType::type_n<N>は玉ねぎの皮を一枚ずつむくようなメンバテンプレートになる。 プライマリの実装は以下のようになる。

    //  example/template/value_type_ut.cpp 91

    template <typename T>
    struct ValueType {
        using type                     = T;
        using type_direct              = T;
        static constexpr size_t extent = 0;
        static constexpr size_t Nest   = 0;

        template <size_t N>
        using type_n = std::conditional_t<N == 0, T, void>;  // Nが0のときはT、それ以外はvoidを返す
    };

Nが非0の場合、Value::type_n<N>はvoidになる仕様にした。

配列に対する特殊化は以下のようになる。

    //  example/template/value_type_ut.cpp 104

    template <typename T, size_t N>  // Array Tを使わずに配列の一般的な表現を使用してNを取り出す
    struct ValueType<T[N]> {         // 配列型の特殊化
        using type                     = typename ValueType<T>::type;
        using type_direct              = T;
        static constexpr size_t extent = N;
        static constexpr size_t Nest   = ValueType<T>::Nest + 1;

        template <size_t M>
        using type_n = std::conditional_t<M == 0, T[N], typename ValueType<T>::template type_n<M - 1>>;
    };

Value::type_n<>のリカーシブ展開を頭の中で行うことは難しいので、 読者の理解を確かめるため、以下のように順を追って一枚づつ配列の階層を剝ぎ取る様子を見ていく。

    //  example/template/value_type_ut.cpp 126

    // ValueType<int[1][2][3]>の展開について、考えよう。

    // int[1][2][3]は == (int[2][3])[1]であるため、下記の式が成立する
    static_assert(std::is_same_v<ValueType<int[1][2][3]>::type_direct, int[2][3]>);
    static_assert(ValueType<int[1][2][3]>::extent == 1);

    // type_n<M>の仕様は、Mが1の時、配列から1階層を1枚剥ぎ取ることである
    using T1 = ValueType<int[1][2][3]>::type_n<1>;  // 長い式は可読性が劣化するからT1を宣言

    // int[2][3] == (int[3])[2]であるため、下記の式が成立する
    static_assert(std::is_same_v<T1, int[2][3]>);
    static_assert(ValueType<T1>::extent == 2);

    // 上記T1と同様にT2を宣言する
    using T2 = ValueType<T1>::type_n<1>;

    // int[2][3] == (int[3])[2]であるため、下記の式が成立する
    static_assert(std::is_same_v<T2, int[3]>);
    static_assert(ValueType<T2>::extent == 3);

    // 上記T1、T2と同様にT3を宣言する
    using T3 = ValueType<T2>::type_n<1>;

    static_assert(std::is_same_v<T3, int>);
    static_assert(ValueType<T3>::extent == 0);

単体テストは下記のようになる。

    //  example/template/value_type_ut.cpp 155

    using T = int[1][2][3];

    static_assert(std::is_same_v<int[1][2][3], ValueType<T>::type_n<0>>);  // 0枚剝く
    static_assert(std::is_same_v<int[2][3], ValueType<T>::type_n<1>>);     // 1枚剝く
    static_assert(std::is_same_v<int[3], ValueType<T>::type_n<2>>);        // 2枚剝く
    static_assert(std::is_same_v<int, ValueType<T>::type_n<3>>);           // 3枚剝く
    static_assert(std::is_same_v<void, ValueType<T>::type_n<4>>);          // 全部剝く

また、ValueType::NestとValueType::type_n<>の関係に注目すれば、 上記エイリアスTに対して下記が成立する。

    //  example/template/value_type_ut.cpp 178

    using T = ValueTypeT_n<int[1][2][3], 3>;

    static_assert(std::is_same_v<int, T>);
    static_assert(std::is_same_v<int, ValueTypeT_n<T, ValueType<T>::Nest>>);

このテンプレートにコンテナが渡された時の特殊化を与えることができればValueTypeは完成するが、 こういったタイミングで、リファクタリングを行い名前の整理や不要になったコードを削除することは良い習慣である。

これによりValueTypeは下記のようになる。

    //  example/template/value_type_ut.cpp 240

    template <typename T>
    struct ValueType {  // プライマリ
        using type                   = T;
        static constexpr size_t Nest = 0;

        template <size_t N>
        using type_n = std::conditional_t<N == 0, T, void>;
    };

    template <typename T, size_t N>
    struct ValueType<T[N]> {  // 配列型の特殊化
        using type                   = typename ValueType<T>::type;
        static constexpr size_t Nest = ValueType<T>::Nest + 1;

        template <size_t M>
        using type_n = std::conditional_t<M == 0, T[N], typename ValueType<T>::template type_n<M - 1>>;
    };

準備は整ったので上記のValueTypeに下記のようなコンテナ用特殊化を追加する。 この特殊化のテンプレートパラメータの制約にはすでに開発したコンセプトContainerを使用する。

    //  example/template/value_type_ut.cpp 261

    template <Container T>
    struct ValueType<T> {  // コンテナ型の特殊化
        using type                   = typename ValueType<typename T::value_type>::type;
        static constexpr size_t Nest = ValueType<typename T::value_type>::Nest + 1;

        template <size_t N>
        using type_n = std::conditional_t<N == 0, T, typename ValueType<typename T::value_type>::template type_n<N - 1>>;
    };

まずは、追加した特殊化の機能を下記のように単体テストを行う。

    //  example/template/value_type_ut.cpp 278

    using T = int[1][2][3];

    // コンテナ特殊化以外の機能チェック
    static_assert(std::is_same_v<T, ValueType<T>::type_n<0>>);
    static_assert(std::is_same_v<int[2][3], ValueType<T>::type_n<1>>);
    static_assert(std::is_same_v<int[3], ValueType<T>::type_n<2>>);
    static_assert(std::is_same_v<int, ValueType<T>::type_n<3>>);
    static_assert(std::is_same_v<int, ValueType<T>::type>);

次に特殊化がデグレードを起こしていないことを下記のように証明する。

    //  example/template/value_type_ut.cpp 291

    // コンテナ特殊化の機能の機能チェック
    using T = std::vector<std::vector<std::vector<int>>>;

    static_assert(std::is_same_v<T, ValueType<T>::type_n<0>>);
    static_assert(std::is_same_v<int, ValueType<T>::type_n<3>>);
    static_assert(ValueType<T>::Nest == 3);
    static_assert(std::is_same_v<int, ValueType<T>::type>);

ValueTypeの最終的な単体テストのために上記を統合したテストを行う。

    //  example/template/value_type_ut.cpp 303

    // 統合した機能チェック
    using T = std::vector<int[1][2][3]>;

    static_assert(std::is_same_v<T, ValueType<T>::type_n<0>>);
    static_assert(std::is_same_v<int[1][2][3], ValueType<T>::type_n<1>>);
    static_assert(std::is_same_v<int[2][3], ValueType<T>::type_n<2>>);
    static_assert(std::is_same_v<int[3], ValueType<T>::type_n<3>>);
    static_assert(std::is_same_v<int, ValueType<T>::type_n<4>>);
    static_assert(std::is_same_v<int, ValueType<T>::type>);
    static_assert(ValueType<T>::Nest == 4);

    using L = std::list<T>;

    static_assert(std::is_same_v<T, ValueType<L>::type_n<1>>);
    static_assert(std::is_same_v<int[1][2][3], ValueType<L>::type_n<2>>);
    static_assert(std::is_same_v<int, ValueType<T>::type>);
    static_assert(ValueType<L>::Nest == 5);

以上でValueTypeは完成したが、これ以降のこのドキュメントの前準備として、 多少のメンバの追加や調整をした最終のコードを以下に示す。

    //  example/h/nstd_type_traits.h 220

    namespace Nstd {
    template <typename T, typename = void>  // ValueTypeのプライマリ
    struct ValueType {
        using type_direct = void;

        static constexpr bool   IsBuiltinArray{false};
        static constexpr size_t Nest{0};

        template <size_t N>
        using type_n = typename std::conditional_t<N == 0, T, void>;

        using type = type_n<Nest>;
    };

    #if __cplusplus <= 201703L  // c++17
    namespace Inner_ {

    template <typename T, size_t N>
    struct conditional_value_type_n {
        using type =
            typename std::conditional_t<ValueType<T>::Nest != 0,
                                        typename ValueType<typename ValueType<T>::type_direct>::template type_n<N - 1>, T>;
    };

    template <typename T>
    struct conditional_value_type_n<T, 0> {
        using type = T;
    };

    template <typename T, typename = void>
    struct array_or_container : std::false_type {
    };

    template <typename T>
    struct array_or_container<T, typename std::enable_if_t<std::is_array_v<T>>> : std::true_type {
        using type = typename std::remove_extent_t<T>;
    };

    // Tが配列でなく、且つT型インスタンスに範囲for文が適用できるならばstdコンテナと診断する
    template <typename T>
    constexpr bool is_container_v{Nstd::IsRange<T>::value && !std::is_array_v<T>};

    template <typename T>
    struct array_or_container<T, typename std::enable_if_t<is_container_v<T>>> : std::true_type {
        using type = typename T::value_type;
    };

    template <typename T>
    constexpr bool array_or_container_v{array_or_container<T>::value};
    }  // namespace Inner_

    template <typename T>  // ValueTypeの特殊化
    struct ValueType<T, typename std::enable_if_t<Inner_::array_or_container_v<T>>> {
        using type_direct = typename Inner_::array_or_container<T>::type;

        static constexpr bool   IsBuiltinArray{std::is_array_v<T>};
        static constexpr size_t Nest{ValueType<type_direct>::Nest + 1};

        template <size_t N>
        using type_n = typename Inner_::conditional_value_type_n<T, N>::type;

        using type = type_n<Nest>;
    };
    #else  // c++17

    template <typename T, size_t N>
    struct ValueType<T[N]> {  // 配列型の特殊化
        using type_direct = T;

        static constexpr bool   IsBuiltinArray{true};
        static constexpr size_t Nest{ValueType<type_direct>::Nest + 1};

        template <size_t M>
        using type_n = std::conditional_t<M == 0, T[N], typename ValueType<T>::template type_n<M - 1>>;

        using type = type_n<Nest>;
    };

    template <Container T>  // ValueTypeの特殊化
    struct ValueType<T> {   // コンセプトによるSFINAEの回避
        using type_direct = typename T::value_type;

        static constexpr bool   IsBuiltinArray{false};
        static constexpr size_t Nest{ValueType<type_direct>::Nest + 1};

        template <size_t N>
        using type_n = std::conditional_t<N == 0, T, typename ValueType<typename T::value_type>::template type_n<N - 1>>;

        using type = type_n<Nest>;
    };
    #endif

    template <typename T>
    using ValueTypeT = typename ValueType<T>::type;

    template <typename T, size_t N>
    using ValueTypeT_n = typename ValueType<T>::template type_n<N>;
    }  // namespace Nstd

Nstdライブラリの開発2

ここでは予定していた通りSafeArray2を開発し、その後Nstdに必要なライブラリの開発を続ける。

SafeArray2の開発

安全な配列型コンテナ」で断念したSafeArray2の開発を再開する前に、 SafeArray2の要件をまとめると、

となる。この要件を満たすためには、SafeArrayが

    //  example/template/safe_vector_ut.cpp 155

    template <typename... ARGS>  // コンストラクタを定義
    SafeArray(ARGS... args) : base_type{args...}
    {
    }

で行っていた初期化を、SafeArray2では、 「縮小型変換が起こるか否かによる場合分けを行い、 それぞれの場合に対応するコンストラクタテンプレートによって初期化」 するようにすれば良いことがわかる。

パラメータパックによるコンストラクタのシグネチャは上記した一種類しかないため、 関数のシグネチャの差異よるオーバーロードは使えない。 とすれば、テンプレートパラメータの型の差異によるオーバーロードを使うしか方法がない。 縮小型変換が起こるか否かの場合分けは、 コンセプトConvertibleWithoutNarrowingを使用したSFINAEで実現させることができる。 という風な思考の変遷により以下のコードにたどり着く。

    //  example/template/safe_vector_ut.cpp 228
namespace Nstd {

template <typename T, size_t N>
struct SafeArray2 : std::array<T, N> {
    using std::array<T, N>::array;  // 継承コンストラクタ
    using base_type = std::array<T, N>;

    // 縮小型変換した場合には、ill-formedになるコンストラクタ
    /* c++17スタイルのSFINAE
    template <typename... ARGS,
              typename = 
                  typename std::enable_if_t<
                       AreConvertibleWithoutNarrowConvV<T, ARGS...>>>
    */ 
    template <typename... ARGS> // C++20のコンセプトを使用したSFINAE
    requires ConvertibleWithoutNarrowing<T, ARGS...>
    SafeArray2(ARGS... args) : base_type{args...} // 初期化子リストによるarrayの初期化
    {
    }

    // 縮小型変換しない場合には、ill-formedになるコンストラクタ
    /* C++17までのSFINAE
    template <typename... ARGS, 
              typename std::enable_if_t<
                  !AreConvertibleWithoutNarrowConvV<T, ARGS...>>* = nullptr>
    */
    template <typename... ARGS> // C++20のコンセプトを使用したSFINAE
    requires (!ConvertibleWithoutNarrowing<T, ARGS...>)  // この行には()が必要
    SafeArray2(ARGS... args) :
        base_type{T(args)...},  // 縮小型変換を抑止するため、T(args)が必要
        is_with_narrow_conv_{true}
    {
    }

    using size_type = typename base_type::size_type;

    typename base_type::reference       operator[](size_type i) { return this->at(i); }
    typename base_type::const_reference operator[](size_type i) const { return this->at(i); }

    bool InitWithNarrowing() const noexcept { return is_with_narrow_conv_; }

private:
    bool const is_with_narrow_conv_{false};
};
}  // namespace Nstd

下記のようなコードでのコンストラクタ呼び出しには、

    //  example/template/safe_vector_ut.cpp 299

    auto sa_init = Nstd::SafeArray2<int, 3>{1, 2, 3};

上記の抜粋である下記のコンストラクタが置換失敗により排除される(SFINAE)。

    //  example/template/safe_vector_ut.cpp 252

    // 縮小型変換しない場合には、ill-formedになるコンストラクタ
    /* C++17までのSFINAE
    template <typename... ARGS, 
              typename std::enable_if_t<
                  !AreConvertibleWithoutNarrowConvV<T, ARGS...>>* = nullptr>
    */
    template <typename... ARGS> // C++20のコンセプトを使用したSFINAE
    requires (!ConvertibleWithoutNarrowing<T, ARGS...>)  // この行には()が必要
    SafeArray2(ARGS... args) :
        base_type{T(args)...},  // 縮小型変換を抑止するため、T(args)が必要
        is_with_narrow_conv_{true}
    {
    }

従って、マッチするコンストラクタは

    //  example/template/safe_vector_ut.cpp 237

    // 縮小型変換した場合には、ill-formedになるコンストラクタ
    /* c++17スタイルのSFINAE
    template <typename... ARGS,
              typename = 
                  typename std::enable_if_t<
                       AreConvertibleWithoutNarrowConvV<T, ARGS...>>>
    */ 
    template <typename... ARGS> // C++20のコンセプトを使用したSFINAE
    requires ConvertibleWithoutNarrowing<T, ARGS...>
    SafeArray2(ARGS... args) : base_type{args...} // 初期化子リストによるarrayの初期化
    {
    }

のみとなり、無事にコンパイルが成功し、下記の単体テストもパスする。

    //  example/template/safe_vector_ut.cpp 299

    auto sa_init = Nstd::SafeArray2<int, 3>{1, 2, 3};

    ASSERT_FALSE(sa_init.InitWithNarrowing());  // 縮小型変換なし
    ASSERT_EQ(3, sa_init.size());
    ASSERT_EQ(1, sa_init[0]);
    ASSERT_EQ(2, sa_init[1]);
    ASSERT_EQ(3, sa_init[2]);
    ASSERT_THROW(sa_init[3], std::out_of_range);

下記の単体テストの場合、SFINAEにより、先述の例とは逆のコンストラクタが選択され、 コンパイルも単体テストもパスする。

    //  example/template/safe_vector_ut.cpp 314
    auto const sa_init = Nstd::SafeArray2<int, 3>{10, 20, 30.0};  // 30.0はintに縮小型変換される

    ASSERT_TRUE(sa_init.InitWithNarrowing());  // 縮小型変換あり
    ASSERT_EQ(3, sa_init.size());
    ASSERT_EQ(10, sa_init[0]);
    ASSERT_EQ(20, sa_init[1]);
    ASSERT_EQ(30, sa_init[2]);
    ASSERT_THROW(sa_init[3], std::out_of_range);

ここで紹介したC++17スタイルの2つのコンストラクタテンプレートの最後のパラメータには、 かなりの違和感があるだろうが、 引数や戻り値に制限の多いコンストラクタテンプレートでSFINAEを起こすためには、 このような記述が必要になる。 一方でコンセプトを使用したC++20スタイルのSFINAEの可読性の高さを実感できただろう。

なお、2つ目のコンストラクタテンプレートの中で使用した下記のコードは、 パラメータパックで与えられた全引数をそれぞれにT型オブジェクトに変換するための記法である。

    //  example/template/safe_vector_ut.cpp 264

    base_type{T(args)...},  // 縮小型変換を抑止するため、T(args)が必要

これにより、std::array<T, N>のstd::initializer_listによる初期化が縮小変換を検出しなくなる。

Nstd::SafeIndexの開発

安全なvector」、「安全な配列型コンテナ」等の中で、

を定義した。これらは少しだけランタイム速度を犠牲にすることで、 安全な(未定義動作を起こさない)インデックスアクセスを保障するため、 一般のソフトウェア開発にも有用であると思われるが、コードクローンして作ったため、 リファクタリングを行う必要がある。

まずは、Nstd::SafeVectorとNstd::SafeStringの統一を考える。

std::stringは、実際にはstd::basic_string<char>のエイリアスであることに注目すれば、 Nstd::SafeStringの基底クラスはstd::basic_string<char>であることがわかる。 この形式は、std::vector<T>と同形であるため、 Nstd::SafeVectorとNstd::SafeStringの共通コードはテンプレートテンプレートパラメータ (「is_same_templ」参照)を使用し下記のように書ける。

    //  example/template/nstd_safe_index.h 8

    namespace Nstd {

    template <template <class...> class C, typename... Ts>
    struct SafeIndex : C<Ts...> {
        using C<Ts...>::C;

        using base_type = C<Ts...>;
        using size_type = typename base_type::size_type;

        typename base_type::reference       operator[](size_type i) { return this->at(i); }
        typename base_type::const_reference operator[](size_type i) const { return this->at(i); }
    };
    }  // namespace Nstd

このコードの使用例を兼ねた単体テストは下記のようになる。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 8

    auto v_i = Nstd::SafeIndex<std::vector, int>{1, 2};

    static_assert(std::is_same_v<int&, decltype(v_i[0])>);
    static_assert(std::is_base_of_v<std::vector<int>, decltype(v_i)>);
    ASSERT_EQ(1, v_i[0]);
    ASSERT_EQ(2, v_i[1]);
    ASSERT_THROW(v_i[2], std::out_of_range);

    auto str = Nstd::SafeIndex<std::basic_string, char>{"123"};

    static_assert(std::is_same_v<char&, decltype(str[0])>);
    static_assert(std::is_base_of_v<std::string, decltype(str)>);
    ASSERT_EQ(3, str.size());
    ASSERT_EQ("123", str);
    ASSERT_THROW(str[3], std::out_of_range);

このままでは使いづらいので下記のようにエイリアスを使い、元のテンプレートと同じ名前を与える。

    //  example/template/nstd_safe_index.h 24

    namespace Nstd {

    template <typename T>
    using SafeVector = Nstd::SafeIndex<std::vector, T>;

    using SafeString = Nstd::SafeIndex<std::basic_string, char>;
    }  // namespace Nstd

このコードの単体テストは下記のようになる。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 54

    auto v_i = Nstd::SafeVector<int>{1, 2};

    static_assert(std::is_same_v<int&, decltype(v_i[0])>);
    static_assert(std::is_base_of_v<std::vector<int>, decltype(v_i)>);
    ASSERT_EQ(1, v_i[0]);
    ASSERT_EQ(2, v_i[1]);
    ASSERT_THROW(v_i[2], std::out_of_range);

    auto str = Nstd::SafeString{"123"};

    static_assert(std::is_same_v<char&, decltype(str[0])>);
    static_assert(std::is_base_of_v<std::string, decltype(str)>);
    ASSERT_EQ(3, str.size());
    ASSERT_EQ("123", str);
    ASSERT_THROW(str[3], std::out_of_range);

これで、Nstd::SafeVectorとNstd::SafeStringは統一できたので、 Nstd::SafeIndexにNstd::SafeArrayの実装が取り込めれば、リファクタリングは終了となるが、 残念ながら、下記のコードはコンパイルできない。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 44

    // 下記のように書きたいが、パラメータパックは型と値を混在できないのでコンパイルエラー
    auto a_i = Nstd::SafeIndex<std::array, int, 5>{};

理由は、パラメータパックにはそのすべてに型を指定するか、そのすべてに値を指定しなければならず、 上記のコードのような型と値の混在が許されていないからである。

値を型に変換するstd::integral_constantを使用し、この問題を解決できる。 std::arrayから派生した下記のStdArrayLikeは、std::integral_constant::valueから値を取り出し、 基底クラスstd::arrayの第2テンプレートパラメータとする。 この仕組みにより、StdArrayLikeは、 Nstd::SafeIndexのテンプレートテンプレートパラメータとして使用できるようになる。

    //  example/template/nstd_safe_index.h 34

    namespace Nstd {
    namespace Inner_ {

    template <typename T, typename U>
    struct std_array_like : std::array<T, U::value> {
        using std::array<T, U::value>::array;

        template <typename... ARGS>
        std_array_like(ARGS... args) noexcept(std::is_nothrow_constructible_v<T, ARGS...>)
            : std::array<T, U::value>{args...}
        {
            static_assert(ConvertibleToAll<T, ARGS...>, "arguemnt error");
        }
    };
    }  // namespace Inner_
    }  // namespace Nstd

まずは、このコードの使用例を兼ねた単体テストを下記に示す。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 134

    auto sal = Nstd::Inner_::std_array_like<int, std::integral_constant<size_t, 3>>{1, 2, 3};

    static_assert(std::is_nothrow_constructible_v<decltype(sal), int>);  // エクセプション無し生成
    static_assert(std::is_same_v<int&, decltype(sal[0])>);
    static_assert(std::is_base_of_v<std::array<int, 3>, decltype(sal)>);
    ASSERT_EQ(1, sal[0]);
    ASSERT_EQ(2, sal[1]);
    ASSERT_EQ(3, sal[2]);

    using T   = Nstd::Inner_::std_array_like<std::string, std::integral_constant<size_t, 3>>;
    auto sal2 = T{"1", "2", "3"};

    static_assert(!std::is_nothrow_constructible_v<std::string, char const*>);
    static_assert(!std::is_nothrow_constructible_v<T, char const*>);  // エクセプション有り生成
    static_assert(std::is_same_v<std::string&, decltype(sal2[0])>);
    static_assert(std::is_base_of_v<std::array<std::string, 3>, decltype(sal2)>);
    ASSERT_EQ("1", sal2[0]);
    ASSERT_EQ("2", sal2[1]);
    ASSERT_EQ("3", sal2[2]);

これを使えば、下記のような記述が可能となる。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 157

    using T2   = Nstd::SafeIndex<Nstd::Inner_::std_array_like, std::string, std::integral_constant<size_t, 4>>;
    auto sal_s = T2{"1", "2", "3"};

    static_assert(!std::is_nothrow_constructible_v<T2, char const*>);  // エクセプション有り生成
    static_assert(std::is_same_v<std::string&, decltype(sal_s[0])>);
    static_assert(std::is_base_of_v<std::array<std::string, 4>, decltype(sal_s)>);
    ASSERT_EQ("1", sal_s[0]);
    ASSERT_EQ("2", sal_s[1]);
    ASSERT_EQ("3", sal_s[2]);
    ASSERT_EQ("", sal_s[3]);
    ASSERT_THROW(sal_s[4], std::out_of_range);

このままでは使いづらいのでNstd::SafeVector、Nstd::Stringと同様にエイリアスを使えば、 下記のようになる。

    //  example/template/nstd_safe_index.h 53

    namespace Nstd {

    template <typename T, size_t N>
    using SafeArray = Nstd::SafeIndex<Nstd::Inner_::std_array_like, T, std::integral_constant<size_t, N>>;
    }  // namespace Nstd

このコードの単体テストは下記のようになる。

    //  example/template_cpp17/nstd_safe_index_ut.cpp 89

    auto sal_s = Nstd::SafeArray<std::string, 4>{"1", "2", "3"};

    static_assert(std::is_same_v<std::string&, decltype(sal_s[0])>);
    static_assert(std::is_base_of_v<std::array<std::string, 4>, decltype(sal_s)>);
    ASSERT_EQ("1", sal_s[0]);
    ASSERT_EQ("2", sal_s[1]);
    ASSERT_EQ("3", sal_s[2]);
    ASSERT_EQ("", sal_s[3]);
    ASSERT_THROW(sal_s[4], std::out_of_range);

これにより、当初の目的であったコードクローンの除去が完了した。 この効果により、下記に示したような拡張もコードクローンせずに簡単に行えるようになった。

    //  example/template/nstd_safe_index.h 61

    namespace Nstd {

    using SafeStringU16 = Nstd::SafeIndex<std::basic_string, char16_t>;
    using SafeStringU32 = Nstd::SafeIndex<std::basic_string, char32_t>;
    }  // namespace Nstd
    //  example/template_cpp17/nstd_safe_index_ut.cpp 112

    auto u16str = Nstd::SafeStringU16{u"あいうえお"};

    static_assert(std::is_same_v<char16_t&, decltype(u16str[0])>);
    static_assert(std::is_base_of_v<std::u16string, decltype(u16str)>);
    ASSERT_EQ(5, u16str.size());
    ASSERT_EQ(u"あいうえお", u16str);
    ASSERT_THROW(u16str[5], std::out_of_range);

    auto u32str = Nstd::SafeStringU32{U"かきくけこ"};

    static_assert(std::is_same_v<char32_t&, decltype(u32str[0])>);
    static_assert(std::is_base_of_v<std::u32string, decltype(u32str)>);
    ASSERT_EQ(5, u32str.size());
    ASSERT_EQ(U"かきくけこ", u32str);
    ASSERT_THROW(u32str[5], std::out_of_range);

Nstd::SafeIndexのoperator<<の開発

ここでは、Nstd::SafeIndexのoperator<<の開発を行う。

他のoperator<<との間で定義が曖昧にならないようにするためには、 テンプレートテンプレートパラメータを使って以下のようにすることが考えられる。

    //  example/template_cpp17/safe_index_put_to_ut.cpp 8

    template <template <class...> class C, typename... Ts>
    std::ostream& operator<<(std::ostream& os, Nstd::SafeIndex<C, Ts...> const& safe_index)
    {
        auto sep = "";

        for (auto const& i : safe_index) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }

以下の単体テストで動作確認する。

    //  example/template_cpp17/safe_index_put_to_ut.cpp 25
    {
        auto v_i = Nstd::SafeVector<int>{1, 2};

        auto oss = std::ostringstream{};
        oss << v_i;
        ASSERT_EQ("1, 2", oss.str());
    }
    {
        auto sal_s = Nstd::SafeArray<std::string, 4>{"1", "2", "3"};
        auto oss   = std::ostringstream{};
        oss << sal_s;
        ASSERT_EQ("1, 2, 3, ", oss.str());  // 4番目には何も入っていない
    }

ここまではうまく行っているが、以下の単体テストによりバグが発覚する。

    //  example/template_cpp17/safe_index_put_to_ut.cpp 40

    {
        auto s_str = Nstd::SafeString{"hello"};
        auto oss   = std::ostringstream{};
        oss << s_str;

        // ASSERT_EQ("hello", oss.s_str());     // これがパス出来たらよいが、
        ASSERT_EQ("h, e, l, l, o", oss.str());  // 実際にはこのようになる。
    }
    {
        auto str = std::string{"hello"};  // 上記と比較のためのstd::stringでのoperator<<

        auto oss = std::ostringstream{};
        oss << str;
        ASSERT_EQ("hello", oss.str());
    }

この原因は、Nstd::SafeStringオブジェクトに対して、std::operator<<が使用されなかったからである。

メタ関数のテクニック」で紹介したSFINAEによりこの問題を回避できるが、 ここでも、すでにみてきたコンセプトによる制約によりこの問題に対処する。

    //  example/template_cpp17/safe_index_put_to_ut.cpp 98


    #if __cplusplus >= 202002L  // c++20
    namespace Inner_ {
    template <typename T>
    concept not_safe_string = !std::is_same_v<T, Nstd::SafeString>;
    }
    #endif

    template <template <class...> class C, typename... Ts>
    #if __cplusplus >= 202002L  // c++20
    auto operator<<(std::ostream& os, Nstd::SafeIndex<C, Ts...> const& safe_index) -> std::ostream& 
        requires Inner_::not_safe_string<Nstd::SafeIndex<C, Ts...>> // enable_ifによるSFINAEを避け、

    #else  // c++17
    auto operator<<(std::ostream& os, Nstd::SafeIndex<C, Ts...> const& safe_index) ->
        typename std::enable_if_t<    // safe_indexがSafeString型ならば、SFINAEにより非活性化
            !std::is_same_v<Nstd::SafeIndex<C, Ts...>, Nstd::SafeString>, std::ostream&>
    #endif
    {  // コンセプトによる制約
        auto sep = "";

        for (auto const& i : safe_index) {
            os << std::exchange(sep, ", ") << i;
        }

        return os;
    }

これにより先ほど問題が発生した単体テストも下記のようにパスする。

    //  example/template_cpp17/safe_index_put_to_ut.cpp 145

    auto str = Nstd::SafeString{"hello"};
    auto oss = std::ostringstream{};
    oss << str;
    ASSERT_EQ("hello", oss.str());  // std::operator<<が使われる
    // ASSERT_EQ("h, e, l, l, o", oss.str());

コンテナ用Nstd::operator<<の開発

Nstd::SafeIndexのoperator<<の開発」で定義したNstd::operator<<の構造は、 範囲for文に適用できる配列やstdコンテナにも使えるため、ここではその拡張を考える。

すでに述べたように注意すべきは、

であるため、型Tが新しいNstd::operator<<を使用できる条件は、

となるだろう。この条件を診断するためのメタ関数は以下のようになる。

    //  example/template/nstd_put_to.h 17

    namespace Nstd {
    namespace Inner_ {

    template <typename T>  // Nstd::Printableを使用するとg++のバグで、問題が発生するため、
                           // バグ回避のため敢えてここでNstd::Inner_::Printableを宣言する
    concept Printable = requires(T t, std::ostream& os)
    {
        { os << t } -> std::same_as<std::ostream&>;
    };

    template <typename T>
    constexpr bool enable_range_put_to() noexcept
    {
        if constexpr (Nstd::ValueType<T>::IsBuiltinArray) {  // Tは配列
            if constexpr (std::is_same_v<char,
                                         typename Nstd::ValueType<T>::type_direct>) {  // Tはchar配列
                return false;
            }
            else {
                return Nstd::Printable<typename Nstd::ValueTypeT<T>>;
            }
        }
        else {  // Tは配列ではない
            if constexpr (Printable<T>) {
                return false;
            }
            else {
                if constexpr (Nstd::IsRangeV<T>) {  // 範囲for文に適用できる
                    return Nstd::Printable<typename Nstd::ValueTypeT<T>>;
                }
                else {
                    return false;
                }
            }
        }
    }

    template <typename T>
    constexpr bool enable_range_put_to_v{enable_range_put_to<T>()};
    }  // namespace Inner_
    }  // namespace Nstd

ただし、このようなコードはコンパイラのバグによりコンパイルできないことがある。 実際、現在使用中のg++ではこのコードはコンパイルできず、 上記コードでコメントにも書いた通り、Inner_の中でPrintableを再定義することで、 そのワークアラウンドを行っている。

このような場合、条件分岐に三項演算子や中間式にconstexprを使うことで回避できることが多い。 このような複雑なメタ関数には単体テストは必須である。

    //  example/template/test_class.h 3

    class test_class_exits_put_to {
    public:
        test_class_exits_put_to(int i = 0) noexcept : i_{i} {}
        int get() const noexcept { return i_; }

    private:
        int i_;
    };

    inline std::ostream& operator<<(std::ostream& os, test_class_exits_put_to const& p) { return os << p.get(); }

    class test_class_not_exits_put_to {};
    //  example/template/nstd_put_to_ut.cpp 31

    static_assert(enable_range_put_to_v<int[3]>);                         // Nstd::operator<<
    static_assert(!enable_range_put_to_v<char[3]>);                       // std::operator<<
    static_assert(!enable_range_put_to_v<int>);                           // std::operator<<
    static_assert(enable_range_put_to_v<std::vector<int>>);               // Nstd::operator<<
    static_assert(enable_range_put_to_v<std::vector<std::vector<int>>>);  // Nstd::operator<<
    static_assert(!enable_range_put_to_v<std::string>);                   // std::operator<<
    static_assert(enable_range_put_to_v<std::vector<std::string>>);       // Nstd::operator<<

    static_assert(!enable_range_put_to_v<test_class_not_exits_put_to>);               // operator<<無し
    static_assert(!enable_range_put_to_v<test_class_exits_put_to>);                   // ユーザ定義operator<<
    static_assert(!enable_range_put_to_v<std::vector<test_class_not_exits_put_to>>);  // operator<<無し
    static_assert(enable_range_put_to_v<std::vector<test_class_exits_put_to>>);       // Nstd::operator<<
    static_assert(!enable_range_put_to_v<std::list<test_class_not_exits_put_to>>);    // operator<<無し
    static_assert(enable_range_put_to_v<std::list<test_class_exits_put_to>>);         // Nstd::operator<<

以上によりstd::enable_ifの第1引数に渡す値(enable_range_put_to_vはconstexpr)が用意できたので、 Nstd::operator<<は下記のように定義できる。

    //  example/template/nstd_put_to.h 64

    namespace Nstd {
    namespace Inner_ {

    template <size_t N>
    constexpr std::string_view range_put_to_sep() noexcept
    {
        static_assert(N != 0);
        switch (N) {
        case 1:
            return ", ";
        case 2:
            return " | ";
        case 3:
        default:
            return " # ";
        }
    };

    template <typename T>
    concept range_put_to = Inner_::enable_range_put_to_v<T>;
    }  // namespace Inner_

    template <typename T>
    auto operator<<(std::ostream& os, T const& t) ->
        typename std::enable_if_t<Inner_::enable_range_put_to_v<T>, std::ostream&>
    // std::enable_if_t<Inner_::enable_range_put_to_v<T>を使わずに上のrange_put_toを使いたいが、
    // コンパイラのバグによりコンパイルできない
    {
        auto sep = std::string_view("");
        auto s   = Inner_::range_put_to_sep<ValueType<T>::Nest>();

        for (auto const& i : t) {
            os << std::exchange(sep, s) << i;
        }

        return os;
    }
    }  // namespace Nstd

値表示用のセパレータに”,“のみを用いるとコンテナや配列が多次元(ValueType::Nest > 2)の場合、 各次元でのデータの判別が難しくなるため、ValueType::Nestの値によってセパレータの種類を変える range_put_to_sep<>()を用意した。 下記単体テストでわかる通り、この効果により値の構造が見やすくなっている。

まずは、配列の単体テストを示す。

    //  example/template/nstd_put_to_ut.cpp 111

    using namespace Nstd;
    {
        char str[] = "abcdef";
        auto oss   = std::ostringstream{};

        oss << str;  // std::operator<<
        ASSERT_EQ(str, oss.str());
    }
    {
        char str[2][4] = {"abc", "def"};
        auto oss       = std::ostringstream{};

        oss << str;  // Nstd::operator<<
        ASSERT_EQ("abc | def", oss.str());
    }
    {
        test_class_exits_put_to p1[3]{1, 2, 3};
        auto                    oss = std::ostringstream{};

        oss << p1;  // Nstd::operator<<
        ASSERT_EQ("1, 2, 3", oss.str());
    }
    {
        char const* str[] = {"abc", "def", "ghi"};
        auto        oss   = std::ostringstream{};

        oss << str;  // Nstd::operator<<
        ASSERT_EQ("abc, def, ghi", oss.str());
    }
    {
        int  v[2][3][2]{{{0, 1}, {2, 3}, {4, 5}}, {{6, 7}, {8, 9}, {10, 11}}};
        auto oss = std::ostringstream{};

        oss << v;
        ASSERT_EQ("0, 1 | 2, 3 | 4, 5 # 6, 7 | 8, 9 | 10, 11", oss.str());
    }

次に、コンテナの単体テストを示す。

    //  example/template/nstd_put_to_ut.cpp 168

    using namespace Nstd;
    {
        auto v   = std::vector<int>{1, 2, 3};
        auto oss = std::ostringstream{};

        oss << v;
        ASSERT_EQ("1, 2, 3", oss.str());
    }
    {
        auto p1  = std::list<test_class_exits_put_to>{1, 2, 3, 4};
        auto oss = std::ostringstream{};

        oss << p1;
        ASSERT_EQ("1, 2, 3, 4", oss.str());
    }
    {
        std::vector<int> v[2]{{1, 2}, {3, 4, 5}};  // std::vectorの配列
        auto             oss = std::ostringstream{};

        oss << v;
        ASSERT_EQ("1, 2 | 3, 4, 5", oss.str());
    }

最後に、Nstd::SafeIndexの単体テストを示す。

    //  example/template/nstd_put_to_ut.cpp 218

    {
        auto sal_s = Nstd::SafeArray<std::string, 4>{"1", "2", "3"};
        auto oss   = std::ostringstream{};

        oss << sal_s;
        ASSERT_EQ("1 | 2 | 3 | ", oss.str());
    }
    {
        auto sv  = Nstd::SafeVector<Nstd::SafeArray<Nstd::SafeString, 2>>{{"ab", "cd"}, {"ef", "gh"}};
        auto oss = std::ostringstream{};

        oss << sv;
        ASSERT_EQ("ab | cd # ef | gh", oss.str());
    }

Nstdライブラリの開発3(浮動小数点関連)

浮動小数点型を頻繁に使用するソフトウェアの開発を行うに場合、 ソースコードの中で、場当たり的に浮動小数点型を使用すると、 浮動小数点の誤差浮動小数点の演算エラー にまつわるバグの修正に多くの工数をロスしてしまうことになる。

これらの課題に対処するため、この節は浮動小数点演算によるバグを未然に防ぎ、 精度を確保するための機能を提供することを目的としている。 浮動小数点の比較方法や、 浮動小数点を避けて高精度な演算を実現する固定小数点クラスおよび有理数クラスを導入し、 さらにそれらを簡単に使用できるリテラル表記もサポートしている。

浮動小数点の比較

浮動小数点の演算には下記に示したような問題が起こり得るため、単純な==の比較はできない。

    //  example/template_cpp17/nstd_float_ut.cpp 9

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    ASSERT_FALSE(0.05F == a + b);  // a + b == 0.05Fは一般には成立しない。

この問題に対処するのが以下のコードである。

    //  example/template_cpp17/nstd_float_ut.cpp 17

    float epsilon  = std::abs(0.05F - (a + b));
    bool  is_equal = epsilon <= std::numeric_limits<float>::epsilon();
    ASSERT_TRUE(is_equal);

単なる浮動小数変数の比較にこのようなコードを書くのは間違えやすいし、非効率であるため、 下記のような関数(float用とdouble用)で対処することが一般的である。

    //  example/template_cpp17/nstd_float_ut.cpp 25

    namespace Nstd {

    /// @brief float比較用関数
    bool is_equal_f(float lhs, float rhs) noexcept { return std::abs(lhs - rhs) <= std::numeric_limits<float>::epsilon(); }

    /// @brief double比較用関数
    bool is_equal_d(double lhs, double rhs) noexcept
    {
        return std::abs(lhs - rhs) <= std::numeric_limits<double>::epsilon();
    }

実際に使う場面を以下に示す。

    //  example/template_cpp17/nstd_float_ut.cpp 41

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    // floatの比較はis_equal_fのような関数を使う。
    bool is_equal = Nstd::is_equal_f(0.05F, a + b);
    ASSERT_TRUE(is_equal);

一見これで万事うまくいくように見えるが、そうは行かないことを以下の例で示す。

    //  example/template_cpp17/nstd_float_ut.cpp 56

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    // a + bはfloatの精度のまま、is_equal_dの引数の型であるdoubleに昇格される。
    // 一方、0.05はdoubleであるため(循環小数をdoubleの精度で切り捨てた値であるため)、
    // a + b(floatの精度の値)と0.05の差はdoubleのepsilonを超える。
    //  ASSERT_TRUE(is_equal_d(0.05, a + b));  // NG
    ASSERT_FALSE(Nstd::is_equal_d(0.05, a + b));

dobuleとfloatを1つの式に混載するとfloatがdoubleに昇格されるため、このような問題が起こり得る。 これに対処する方法を以下に示す。

    //  example/template_cpp17/nstd_float_ut.cpp 71

    namespace Nstd {
    // is_equal_dを改良して、引数の型が統一されていない呼び出しをコンパイルエラーにできるようにした。
    /// @brief 浮動小数点比較用関数
    template <typename FLOAT_0, typename FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs) noexcept
    {
        static_assert(std::is_floating_point_v<FLOAT_0>);
        static_assert(std::is_same_v<FLOAT_0, FLOAT_1>);

        return std::abs(lhs - rhs) <= std::numeric_limits<FLOAT_0>::epsilon();
    }
    }  // namespace Nstd

この関数のテストは以下の通りである。

    //  example/template_cpp17/nstd_float_ut.cpp 88

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    // a + bはfloatであり、0.05はdoubleであるため、下記コードはコンパイルできない。
    // ASSERT_TRUE(Nstd::is_equal(0.05, a + b));
    ASSERT_TRUE(Nstd::is_equal(0.05F, a + b));  // OK リテラルに型を指定して、引数の型を統一

通常の浮動小数の比較は相対誤差を指定できる必要性がある場合が多いため、 さらに下記のように拡張変更した。

    //  example/template_cpp17/nstd_float_ut.cpp 103

    /// @brief 浮動小数点比較用関数
    /// 相対誤差を考慮して、lhs と rhs の絶対値に基づくトレランスの範囲内での比較を行う。
    /// これにより、数値の大小に関わらず、適切な誤差で比較できる。
    template <typename FLOAT_0, typename FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs, FLOAT_0 tolerance = std::numeric_limits<FLOAT_0>::epsilon()) noexcept
    {
        static_assert(std::is_floating_point_v<FLOAT_0>);
        static_assert(std::is_same_v<FLOAT_0, FLOAT_1>);

        return std::abs(lhs - rhs) <= tolerance * std::max(std::abs(lhs), std::abs(rhs));
    }

この関数のテストは以下の通りである。

    //  example/template_cpp17/nstd_float_ut.cpp 121

    float a = 1000000.0F;
    float b = 1000000.1F;

    ASSERT_FALSE(Nstd::is_equal(a, b));       // a, bはほぼ同じだが。
    ASSERT_TRUE(Nstd::is_equal(a, b, 0.1F));  // 相対誤差を指定できる。

固定小数点クラス

以上で見てきたように浮動小数点の扱いはやや面倒であるため、 浮動小数点のダイナミックレンジが必要な場合以外では安易に浮動小数点を使うべきでない。

従って、intやlong等のダイナミックレンジで表現できる1未満の値が必要な場合、 intやlongの値を100倍などのスケーリングして使うのが、浮動小数点の微妙な問題を避ける手段となる。 スケーリングとは、 整数型変数変数のスケーリングとは、intやlongの値を、 特定の倍率で拡大することで小数点以下の値を扱う方法を指す。 例えば、100倍にスケーリングして「1.23」を「123」として整数で表現するようする。 この方法は浮動小数点の代わりに使えるが、 スケーリング値を常に意識する必要があり、コードの可読性や保守性に影響を与える問題がある。

以下に示す固定小数点クラス(FixedPoint)はこれらの問題を解決できる。

    //  example/template_cpp17/fixed_point.h 7

    namespace Nstd {
    /// @brief BASIC_TYPEで指定する基本型のビット長を持つ固定小数点を扱うためのクラス
    /// @tparam BASIC_TYPE       全体のビット長や、符号を指定するための整数型
    /// @tparam FRACTION_BIT_NUM 小数点保持のためのビット長
    template <typename BASIC_TYPE, uint32_t FRACTION_BIT_NUM>
    class FixedPoint {
    public:
        constexpr FixedPoint(BASIC_TYPE integer = 0, typename std::make_unsigned_t<BASIC_TYPE> fraction = 0) noexcept
            : value_{get_init_value(integer, fraction)}
        {
            // signedに対する右ビットシフトの仕様が、算術右ビットシフトでないと
            // このクラスは成立しない。下記のstatic_assertはその確認。
            static_assert(IsSigned() ? (-1 >> 1 == -1) : true, "need logical right bit sift");

            // BASIC_TYPEをcharにすることは認めない。
            static_assert(!std::is_same_v<BASIC_TYPE, char>, "BASIC_TYPE should not be char");
        }

        // 以下、特殊メンバ定義
        ~FixedPoint()                                = default;
        FixedPoint(FixedPoint const&)                = default;
        FixedPoint& operator=(FixedPoint const&)     = default;
        FixedPoint(FixedPoint&&) noexcept            = default;
        FixedPoint& operator=(FixedPoint&&) noexcept = default;

        // 以下、インターフェース定義
        constexpr BASIC_TYPE GetValue() const noexcept { return value_; }
        constexpr BASIC_TYPE GetInteger() const noexcept { return value_ >> fraction_bit_num_; }
        constexpr BASIC_TYPE GetFraction() const noexcept { return value_ & fraction_bit_mask_; }

        /// @brief doubleに変換する
        constexpr double ToFloatPoint() const noexcept
        {
            return GetInteger() + (static_cast<double>(GetFraction()) / (fraction_bit_mask_ + 1));
        }

        /// @brief 小数部のビット長を返す
        constexpr typename std::make_unsigned_t<BASIC_TYPE> GetFractionMask() const noexcept { return fraction_bit_mask_; }

        /// @brief 整数部のビット長を返す
        constexpr typename std::make_unsigned_t<BASIC_TYPE> GetIntegerMask() const noexcept { return integer_bit_mask_; }

        static constexpr bool IsSigned() noexcept { return std::is_signed_v<BASIC_TYPE>; }

        static constexpr bool IsUnsigned() noexcept { return std::is_unsigned_v<BASIC_TYPE>; }

        /// @brief    以下operator @=の定義
        FixedPoint& operator+=(FixedPoint rhs) noexcept
        {
            value_ += rhs.value_;
            return *this;
        }

        FixedPoint& operator-=(FixedPoint rhs) noexcept
        {
            value_ -= rhs.value_;
            return *this;
        }

        FixedPoint& operator*=(FixedPoint rhs) noexcept
        {
            value_ *= rhs.value_ >> fraction_bit_num_;
            return *this;
        }

        FixedPoint& operator/=(FixedPoint rhs) noexcept
        {
            using T = std::conditional_t<IsSigned(), int64_t, uint64_t>;

            value_ = (static_cast<T>(value_) << fraction_bit_num_) / rhs.value_;

            return *this;
        }

    private:
        BASIC_TYPE value_;  // FixedPointの実際の値

        static constexpr uint32_t bit_mask(uint32_t bit_len) noexcept
        {
            if (bit_len == 0) {
                return 0x0;
            }

            return bit_mask(bit_len - 1) | (0x01 << (bit_len - 1));
        }

        static constexpr uint32_t fraction_bit_num_{FRACTION_BIT_NUM};
        static constexpr uint32_t fraction_bit_mask_{bit_mask(fraction_bit_num_)};
        static constexpr uint32_t integer_bit_num_{sizeof(BASIC_TYPE) * 8 - FRACTION_BIT_NUM};
        static constexpr uint32_t integer_bit_mask_{bit_mask(integer_bit_num_) << fraction_bit_num_};

        static constexpr BASIC_TYPE get_init_value(BASIC_TYPE integer, BASIC_TYPE fraction) noexcept
        {
            // 本来は左シフト<<を使いたいが、signedに対しての<<ランタイム実装依存であるので、
            // return (integer << fraction_bit_num_) | fraction;

            return (integer * (fraction_bit_mask_ + 1)) | fraction;
        }

        /// 以下比較演算子の定義

    #if __cplusplus >= 202002L  // c++20
        friend auto operator<=>(FixedPoint lhs, FixedPoint rhs) noexcept = default;

    #else  // c++17
        friend bool operator==(FixedPoint lhs, FixedPoint rhs) noexcept { return lhs.value_ == rhs.value_; }

        friend bool operator!=(FixedPoint lhs, FixedPoint rhs) noexcept { return !(lhs == rhs); }

        friend bool operator>(FixedPoint lhs, FixedPoint rhs) noexcept { return lhs.value_ > rhs.value_; }

        friend bool operator>=(FixedPoint lhs, FixedPoint rhs) noexcept { return (lhs > rhs) || (lhs == rhs); }

        friend bool operator<(FixedPoint lhs, FixedPoint rhs) noexcept { return (rhs > lhs); }

        friend bool operator<=(FixedPoint lhs, FixedPoint rhs) noexcept { return (lhs < rhs) || (lhs == rhs); }
    #endif

        /// @brief FixedPoint() + intのようなオーバーロードを作るためにあえてfriend
        friend FixedPoint operator+(FixedPoint lhs, FixedPoint rhs) noexcept
        {
            lhs += rhs;
            return lhs;
        }

        friend FixedPoint operator-(FixedPoint lhs, FixedPoint rhs) noexcept
        {
            lhs -= rhs;
            return lhs;
        }

        friend FixedPoint operator*(FixedPoint lhs, FixedPoint rhs) noexcept
        {
            lhs *= rhs;
            return lhs;
        }

        friend FixedPoint operator/(FixedPoint lhs, FixedPoint rhs) noexcept
        {
            lhs /= rhs;
            return lhs;
        }
    };

FixedPointの単体テストコードを以下に示す。

    //  example/template_cpp17/fixed_point_ut.cpp 21

    // 以下は、FixedPoint<>の使用例である。
    using FP4 = Nstd::FixedPoint<uint8_t, 4>;  // 基本型uint8_t、小数点4ビット
    auto fp0  = FP4{};

    ASSERT_FALSE(fp0.IsSigned());
    ASSERT_TRUE(fp0.IsUnsigned());

    fp0 = 7;    ASSERT_EQ(7, fp0);
    fp0 = 7;    ASSERT_NE(6, fp0);
    fp0 += 2;   ASSERT_EQ(FP4{9}, fp0);         
                ASSERT_DOUBLE_EQ(9.0, fp0.ToFloatPoint());
    fp0 /= 2;   ASSERT_EQ((FP4{4, 8}), fp0);    
                ASSERT_DOUBLE_EQ(4.5, fp0.ToFloatPoint());
    fp0 /= 2;   ASSERT_EQ((FP4{2, 4}), fp0);    
                ASSERT_DOUBLE_EQ(2.25, fp0.ToFloatPoint());
    fp0 *= 4;   ASSERT_EQ(FP4{9}, fp0);
    fp0 += 7;   ASSERT_EQ(FP4{0}, fp0);

固定小数点リテラル

固定小数点クラスのようなクラス定義には、以下に示すようにユーザ定義リテラルを定義し、 使い勝手のよい環境をユーザに提供するべきである。

    //  example/template_cpp17/fixed_point.h 156

    namespace Nstd {
    namespace fixed_point_literals {
    // FixedPoint<int32_t, 8> 用のユーザ定義リテラル
    FixedPoint<int32_t, 8> operator"" _fxp(unsigned long long int val)
    {
        // 整数部分を取り、FixedPoint<int32_t, 8>のインスタンスを作成
        return FixedPoint<int32_t, 8>(static_cast<int32_t>(val));
    }

    FixedPoint<int32_t, 8> operator"" _fxp(long double val)
    {
        // 浮動小数点数からFixedPoint<int32_t, 8>のインスタンスを作成
        int32_t integer_part  = static_cast<int32_t>(val);
        int32_t fraction_part = static_cast<int32_t>((val - integer_part) * 256);  // 2^8 = 256
        return FixedPoint<int32_t, 8>(integer_part, fraction_part);
    }
    }  // namespace fixed_point_literals
    }  // namespace Nstd

以上のコードの単体テストを以下に示す。これにより使用方も明らかになるだろう。

    //  example/template_cpp17/fixed_point_ut.cpp 171

    using namespace Nstd::fixed_point_literals;

    auto a = 123_fxp;  // 整数リテラル

    EXPECT_EQ(a.GetInteger(), 123);
    EXPECT_EQ(a.GetFraction(), 0);  // 小数部は0のはず

    auto b      = 50.25_fxp;
    auto result = a + b;

    EXPECT_NEAR(result.ToFloatPoint(), 173.25, 0.01);

有理数クラス

固定小数点クラスでは精度が足りず、浮動小数点を使用したくない場合、 以下のコードで示す有理数クラスがちょうどよい選択となることがある。

    //  example/template_cpp17/rational.h 10

    namespace Nstd {
    /// @brief ユーザー指定の型で分数を扱うためのクラス
    /// @tparam T 基本の整数型(デフォルトはint32_t)
    #if __cplusplus >= 202002L  // c++20
    template <std::signed_integral T = int32_t>
    #else  // c++17
    template <typename T = int32_t>
    #endif
    class Rational {
    public:
        using underlying_type_t = T;
        /// @brief コンストラクタ
        /// @param num 分子
        /// @param deno 分母
        constexpr Rational(T num, T deno = 1) : value_{reduce(num, deno)} {}
        T getNumerator() const noexcept { return value_.num; }
        T getDenominator() const noexcept { return value_.deno; }
        /// @brief 2項演算子(四則演算)の定義
        Rational operator+(const Rational& rhs) const noexcept
        {
            T num  = value_.num * rhs.value_.deno + rhs.value_.num * value_.deno;
            T deno = value_.deno * rhs.value_.deno;
            return Rational{num, deno};
        }
        Rational operator-(const Rational& rhs) const noexcept
        {
            T num  = value_.num * rhs.value_.deno - rhs.value_.num * value_.deno;
            T deno = value_.deno * rhs.value_.deno;
            return Rational{num, deno};
        }
        Rational operator*(const Rational& rhs) const noexcept
        {
            return Rational{value_.num * rhs.value_.num, value_.deno * rhs.value_.deno};
        }
        Rational operator/(const Rational& rhs) const noexcept
        {
            return Rational(value_.num * rhs.value_.deno, value_.deno * rhs.value_.num);
        }
        /// @brief 複合代入演算子(四則演算)の定義
        Rational& operator+=(Rational const& rhs)
        {
            *this = *this + rhs;
            return *this;
        }
        Rational& operator-=(Rational const& rhs)
        {
            *this = *this - rhs;
            return *this;
        }
        Rational& operator*=(Rational const& rhs)
        {
            *this = *this * rhs;
            return *this;
        }
        Rational& operator/=(Rational const& rhs)
        {
            *this = *this / rhs;
            return *this;
        }
        /// @brief 単項演算子の定義
        constexpr Rational operator+() const noexcept { return *this; }
        constexpr Rational operator-() const noexcept { return Rational{-value_.num, value_.deno}; }
        /// @brief 比較演算子の定義
    #if __cplusplus >= 202002L  // c++20
        friend bool operator==(Rational const& lhs, Rational const& rhs) noexcept = default;
        friend auto operator<=>(Rational const& lhs, Rational const& rhs) noexcept
        {
            return (lhs.value_.num * rhs.value_.deno) <=> (rhs.value_.num * lhs.value_.deno);
        }

    #else  // c++17
        friend bool operator==(Rational const& lhs, Rational const& rhs) noexcept
        {
            return (lhs.value_.num * rhs.value_.deno) == (rhs.value_.num * lhs.value_.deno);
        }
        friend bool operator!=(Rational const& lhs, Rational const& rhs) noexcept { return !(lhs == rhs); }
        friend bool operator<(Rational const& lhs, Rational const& rhs) noexcept
        {
            return (lhs.value_.num * rhs.value_.deno) < (rhs.value_.num * lhs.value_.deno);
        }
        friend bool operator<=(Rational const& lhs, Rational const& rhs) noexcept { return !(rhs < lhs); }
        friend bool operator>(Rational const& lhs, Rational const& rhs) noexcept { return rhs < lhs; }
        friend bool operator>=(Rational const& lhs, Rational const& rhs) noexcept { return !(lhs < rhs); }
    #endif
        /// @brief put-to演算子の定義
        friend std::ostream& operator<<(std::ostream& os, const Rational& rhs)
        {
            return (rhs.value_.deno == 1) ? os << rhs.value_.num : os << rhs.value_.num << "/" << rhs.value_.deno;
        }

        /// @brief doubleへの変換演算子
        /// @brief doubleで表現可能な場合のみ利用可能
        template <typename U = T>
        explicit operator double() const noexcept
    #if __cplusplus >= 202002L  // c++20
            requires std::is_convertible_v<U, double>
    #endif
        {
            return static_cast<double>(value_.num) / static_cast<double>(value_.deno);
        }

    private:
        struct rational_t {
            T num;
            T deno;

    #if __cplusplus >= 202002  // c++20
            friend bool operator==(rational_t const& lhs, rational_t const& rhs) noexcept = default;

    #else  // c++17
            friend bool operator==(rational_t const& lhs, rational_t const& rhs) noexcept
            {
                return lhs.num == rhs.num && lhs.deno == rhs.deno;
            }
    #endif
        };
        /// @brief num/denoを約分して、rational_tで返す
        static rational_t reduce(T num, T deno) noexcept
        {
            T const gcd = std::gcd(num, deno);
            num /= gcd;
            deno /= gcd;
            if (deno < 0) {  // 分母を正に保つ
                return {-num, -deno};
            }
            else {
                return {num, deno};
            }
        }

    private:
        rational_t value_;
    };
    }  // namespace Nstd
    //  example/template_cpp17/rational_ut.cpp 12

    auto       r1    = Rational{1, 2};
    const auto r1_sv = r1;
    auto       r2    = Rational{1, 3};

    ASSERT_GE(r1, r2);

    r1 += r2;  // operator+
    ASSERT_EQ((Rational{5, 6}), r1);
    r1 = r1_sv;

    r1 -= r2;
    ASSERT_EQ((Rational{1, 6}), r1);
    r1 = r1_sv;

    auto oss = std::ostringstream{};
    oss << r1;
    ASSERT_EQ("1/2", oss.str());  // operator<<

有理数リテラル

固定小数点クラスに対して、固定小数点リテラルを定義したように、 使い勝手のよい環境をユーザに提供するために、 有理数クラスに対して、有理数リテラルを定義するべきである。

    //  example/template_cpp17/rational.h 147

    namespace Nstd {
    /// @brief Rational<int32_t>をユーザ定義リテラルとして扱うためのオペレータ
    ///        _rn: rational number
    ///  @param N/Mの形式の文字列リテラル
    Rational<int32_t> operator"" _rn(char const* str, size_t)
    {
        std::string_view input{str};
        size_t           sep = input.find('/');

        if (sep == std::string::npos) {
            throw std::invalid_argument("invalid formt for user-defined rational number");
        }

        int32_t num  = std::stoi(str);
        int32_t deno = std::stoi(input.substr(sep + 1).data());

        return {num, deno};
    }
    }  // namespace Nstd
    //  example/template_cpp17/rational_ut.cpp 55

    auto r1 = "1/2"_rn;
    auto r2 = "1/3"_rn;

    ASSERT_GE(r1, r2);
    ASSERT_DOUBLE_EQ(static_cast<double>(r1), 0.5);

ログ取得ライブラリの開発2

ログ取得ライブラリでの問題は「Logging名前空間が依存してよい名前空間」に

    //  example/template/app_ints.h 6

    namespace App {
    using Ints_t = std::vector<int>;
    }

のようなコンテナに共通したoperator<<を定義することで解決する。 それは 「コンテナ用Nstd::operator<<の開発」で示したコードそのものであるため、 これを使い、問題を解決したログ取得ライブラリを以下に示す。

    //  example/template/logger.h 7

    namespace Logging {
    class Logger {
    public:
        static Logger&       Inst();
        static Logger const& InstConst() { return Inst(); }

        std::string Get() const;  // ログデータの取得
        void        Clear();      // ログデータの消去

        template <typename... ARGS>  // ログの登録
        void Set(char const* filename, uint32_t line_no, ARGS const&... args)
        {
            oss_.width(32);
            oss_ << filename << ":";

            oss_.width(3);
            oss_ << line_no;

            set_inner(args...);
        }

        Logger(Logger const&)            = delete;
        Logger& operator=(Logger const&) = delete;

    private:
        void set_inner() { oss_ << std::endl; }

        template <typename HEAD, typename... TAIL>
        void set_inner(HEAD const& head, TAIL const&... tails)
        {
            using Nstd::operator<<;  // Nstd::operator<<もname lookupの対象にする

            oss_ << ":" << head;
            set_inner(tails...);
        }

        Logger() {}
        std::ostringstream oss_{};
    };
    }  // namespace Logging

    #define LOGGER_P(...) Logging::Logger::Inst().Set(__FILE__, __LINE__)
    #define LOGGER(...) Logging::Logger::Inst().Set(__FILE__, __LINE__, __VA_ARGS__)

問題のあったコードとの差分は、メンバ関数テンプレートset_innerの

    //  example/template/logger.h 40

    using Nstd::operator<<;  // Nstd::operator<<もname lookupの対象にする

のみである。実際に解決できたことを以下の単体テストで示す。

    //  example/template/logger_0_ints_ut.h 8

    auto ints = App::Ints_t{1, 2, 3};

    LOGGER("Ints", ints);
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto exp = std::string{log_str_exp(__FILE__, line_num - 1, ":Ints:1, 2, 3\n")};
    ASSERT_EQ(exp, s);

また、

    //  example/template/app_ints.h 12

    namespace App {

    class X {
    public:
        X(std::string str, int num) : str_{std::move(str)}, num_{num} {}
        std::string ToString() const { return str_ + "/" + std::to_string(num_); }
        // ...
    };
    }  // namespace App

のように定義されたクラスも、

    //  example/template/app_ints.h 28

    namespace App {

    inline std::ostream& operator<<(std::ostream& os, X const& x) { return os << x.ToString(); }
    }  // namespace App

のような型専用のoperator<<があれば、そのオブジェクトのみではなく、 コンテナや配列に対しても下記のようにログ取得が可能となる。

    //  example/template/logger_ut.cpp 37

    using namespace Nstd;

    auto         x  = App::X{"name", 3};
    auto         lx = std::list<App::X>{{"lx3", 3}, {"lx4", 1}};
    App::X const x3[3]{{"x0", 0}, {"x1", 1}, {"x2", 2}};

    LOGGER(1, x, x3, lx);
    auto line_num = __LINE__;

    auto s = Logging::Logger::InstConst().Get();

    auto const exp = log_str_exp(__FILE__, line_num - 1, ":1:name/3:x0/0, x1/1, x2/2:lx3/3, lx4/1\n");
    ASSERT_EQ(exp, s);

Nstdライブラリの開発」で示した依存関係も維持されており、 これでログ取得ライブラリは完成したと言って良いだろう。

その他のテンプレートテクニック

ここでは、これまでの議論の対象にならなかったテンプレートのテクニックや注意点について記述する。

forwardingリファレンスとstd::forward

2個の文字列からstd::vector<std::string>を生成する下記のような関数について考える。

    //  example/template_cpp17/universal_ref_ut.cpp 9

    std::vector<std::string> gen_vector(std::string const& s0, std::string const& s1)
    {
        auto ret = std::vector<std::string>{};

        ret.push_back(s0);
        ret.push_back(s1);

        return ret;
    }

これは下記のように動作する。

    //  example/template_cpp17/universal_ref_ut.cpp 25

    auto a = std::string{"a"};
    auto b = std::string{"b"};

    auto v = gen_vector(a, std::move(b));

    ASSERT_EQ((std::vector<std::string>{"a", "b"}), v);
    ASSERT_EQ("a", a);
    ASSERT_EQ("b", b);  // bはmoveされない

このコードは正しく動作するものの、move代入できず、パフォーマンス問題を引き起こす可能性があるため、 forwardingリファレンスを使って下記のように書き直した。

    //  example/template_cpp17/universal_ref_ut.cpp 41

    template <typename STR0, typename STR1>
    std::vector<std::string> gen_vector(STR0&& s0, STR1&& s1)
    {
        auto ret = std::vector<std::string>{};

        ret.push_back(s0);
        ret.push_back(s1);

        return ret;
    }

残念ながら、このコードは意図したようには動作せず、下記に示した通り相変わらずmove代入ができない。

    //  example/template_cpp17/universal_ref_ut.cpp 58

    auto a = std::string{"a"};
    auto b = std::string{"b"};

    auto v = gen_vector(a, std::move(b));

    ASSERT_EQ((std::vector<std::string>{"a", "b"}), v);
    ASSERT_EQ("a", a);
    ASSERT_EQ("b", b);  // bはmoveされない

この原因は、 「関数が受け取ったrvalueリファレンスは、 その関数から別の関数に受け渡される時にlvalueリファレンスとして扱われる」からである。

この現象について下記の関数テンプレートを用いて解説を行う。

    //  example/template_cpp17/universal_ref_ut.cpp 71

    enum class ExpressionType { Lvalue, Rvalue };

    template <typename T>
    constexpr ExpressionType forwarding_ref2(T&& t)
    {
        return std::is_lvalue_reference_v<decltype(t)> ? ExpressionType::Lvalue : ExpressionType::Rvalue;
    }

    // std::pair<>::first  : forwarding_refの中のtのExpressionType
    // std::pair<>::second : forwarding_ref2の中でtのExpressionType
    template <typename T>
    constexpr std::pair<ExpressionType, ExpressionType> forwarding_ref(T&& t)
    {
        return std::make_pair(std::is_lvalue_reference_v<decltype(t)> ? ExpressionType::Lvalue : ExpressionType::Rvalue,
                              forwarding_ref2(t));
    }

下記に示した通り、forwarding_refとforwarding_ref2のパラメータが同じ型であるとは限らない。

    //  example/template_cpp17/universal_ref_ut.cpp 94

    auto i = 0;

    constexpr auto p = forwarding_ref(i);
    static_assert(forwarding_ref2(i) == ExpressionType::Lvalue);  // iはlvalue
    static_assert(p.first == ExpressionType::Lvalue);             // forwarding_refの引数はlvalue
    static_assert(p.second == ExpressionType::Lvalue);            // forwarding_ref中のforwarding_ref2の引数はlvalue

    constexpr auto pm = forwarding_ref(std::move(i));                        // forwarding_refの引数はrvalue
    static_assert(forwarding_ref2(std::move(i)) == ExpressionType::Rvalue);  // forwarding_ref2の引数はrvalue
    static_assert(pm.first == ExpressionType::Rvalue);                       // forwarding_refの引数はrvalue
    static_assert(pm.second == ExpressionType::Lvalue);                      // forwarding_ref中のforwarding_ref2の引数はrvalue

    constexpr auto pm2 = forwarding_ref(int{});
    static_assert(forwarding_ref2(int{}) == ExpressionType::Rvalue);  // forwarding_ref2の引数はrvalue
    static_assert(pm2.first == ExpressionType::Rvalue);               // forwarding_refの引数はrvalue
    static_assert(pm2.second == ExpressionType::Lvalue);              // forwarding_ref中のforwarding_ref2の引数はrvalue

この問題はstd::forwardにより対処できる。これによって改良されたコードを下記に示す。

    //  example/template_cpp17/universal_ref_ut.cpp 122

    template <typename STR0, typename STR1>
    std::vector<std::string> gen_vector(STR0&& s0, STR1&& s1)
    {
        auto ret = std::vector<std::string>{};

        ret.push_back(std::forward<STR0>(s0));
        ret.push_back(std::forward<STR1>(s1));

        return ret;
    }

下記単体テストが示す通り、rvalueリファレンスはmove代入され、lvalueリファレンスはcopy代入されている。

    //  example/template_cpp17/universal_ref_ut.cpp 140

    auto a = std::string{"a"};
    auto b = std::string{"b"};

    auto v = gen_vector(a, std::move(b));

    ASSERT_EQ((std::vector<std::string>{"a", "b"}), v);
    ASSERT_EQ("a", a);
    ASSERT_EQ("", b);  // bはmoveされた

しかし残念ながら、このコードにも改良すべき点がある。

    //  example/template_cpp17/universal_ref_ut.cpp 153

    auto a = std::string{"a"};

    auto v = gen_vector(a, "b");

    ASSERT_EQ((std::vector<std::string>{"a", "b"}), v);
    ASSERT_EQ("a", a);

上記の”b”のような文字列リテラルを引数にした場合、 それをstd::vector<std::string>::push_backに渡した時に、 “b”はテンポラリオブジェクトstd::string(“b”)のに変換されてしまう。 std::vector<std::string>へのオブジェクトの挿入は、文字列リテラルから行うことが出来るため、 このテンポラリオブジェクトの生成は明らかに不要な処理である。

下記は、この対策を施すとともに任意の数の引数を受け取れるように改良したコードである。

    //  example/template_cpp17/universal_ref_ut.cpp 169

    void emplace_back(std::vector<std::string>&) {}

    template <typename HEAD, typename... TAIL>
    void emplace_back(std::vector<std::string>& strs, HEAD&& head, TAIL&&... tails)
    {
        strs.emplace_back(std::forward<HEAD>(head));

        if constexpr (sizeof...(tails) != 0) {
            emplace_back(strs, std::forward<TAIL>(tails)...);
        }
    }

    template <typename... STR>
    std::vector<std::string> gen_vector(STR&&... ss)
    {
        auto ret = std::vector<std::string>{};

        emplace_back(ret, std::forward<STR>(ss)...);

        return ret;
    }

上記の

    sizeof...(tails)

はパラメータパックの個数を受け取るための記法である。 従ってこのコードではすべてのパラメータパック変数を消費するまでリカーシブコールを続けることになる (が、このリカーシブコールはコンパイル時に行われるため、実行時の速度低下は起こさない)。

上記の

    std::forward<TAIL>(tails)...

は、それぞれのパラメータパック変数をstd::forwardに渡した戻り値を、 再びパラメータパックにするための記法である。

このコードは下記の単体テストが示すように正しく動作する (が、残念ならがテンポラリオブジェクトが生成されていないことを単体テストで証明することはできない)。

    //  example/template_cpp17/universal_ref_ut.cpp 195

    auto a = std::string{"a"};
    auto b = std::string{"b"};

    auto v = gen_vector(a, std::move(b), "c");

    ASSERT_EQ((std::vector<std::string>{"a", "b", "c"}), v);
    ASSERT_EQ("a", a);
    ASSERT_EQ("", b);  // bはmoveされた

上記のgen_vectorはリカーシブコールを使って実装したが、 畳み込み式を使用した下記の実装の方がより明確である。

    //  example/template_cpp17/universal_ref_ut.cpp 209

    template <typename... STR>
    std::vector<std::string> gen_vector(STR&&... ss)
    {
        auto ret = std::vector<std::string>{};

        (ret.emplace_back(std::forward<STR>(ss)), ...);

        return ret;
    }

forwardingリファレンスはconstにすることができないが (T const&&はconstなrvalueリファレンスである)、 forwardingリファレンスがlvalueリファレンスであった場合は、 constなlvalueリファレンスとして扱うべきである。

従って、下記のようなコードは書くべきではない。

    //  example/template_cpp17/universal_ref_ut.cpp 238

    template <typename STR0, typename STR1>
    std::vector<std::string> gen_vector(STR0&& s0, STR1&& s1)
    {
        auto ret = std::vector<std::string>{};

        ret.push_back(std::move(s0));
        ret.push_back(std::move(s1));

        return ret;
    }

もしそのようにしてしまえば、 下記単体テストが示すように非constな実引数はmoveされてしまうことになる。

    //  example/template_cpp17/universal_ref_ut.cpp 255

    auto       a = std::string{"a"};
    auto const b = std::string{"b"};

    auto v = gen_vector(a, std::move(b));

    ASSERT_EQ((std::vector<std::string>{"a", "b"}), v);
    ASSERT_EQ("", a);   // aはmoveされてしまう
    ASSERT_EQ("b", b);  // bはconstなのでmoveされない

任意の型Tのrvalueのみを引数に取る関数テンプレートを下記のように記述した場合、 すでに述べたように引数はforwardingリファレンスとなってしまうため、lvalueにもバインドしてしまう。

    //  example/template_cpp17/universal_ref_ut.cpp 271

    template <typename T>
    void f(T&& t) noexcept
    {
        // ...
    }

このような場合、下記の記述が必要になる。

    //  example/template_cpp17/universal_ref_ut.cpp 290

    template <typename T>
    void f(T&) = delete;

この効果により、下記に示した通りlvalueにはバインドできなくなり、 当初の目的通り、rvalueのみを引数に取る関数テンプレートが定義できたことになる。

    //  example/template_cpp17/universal_ref_ut.cpp 298

    auto s = std::string{};

    // f(s);           // f(std::string&)はdeleteされたため、コンパイルエラー
    f(std::string{});  // f(std::string&&)にはバインドできる

なお、forwardingリファレンスは、リファレンスcollapsingの一機能としても理解できる。

ジェネリックラムダによる関数内での関数テンプレートの定義

下記のようなクラスとoperator<<があった場合を考える。

    //  example/template_cpp17/generic_lambda_ut.cpp 13

    struct XYZ {
        XYZ(int ax, int ay, int az) noexcept : x{ax}, y{ay}, z{az} {}
        int x;
        int y;
        int z;
    };

    std::ostream& operator<<(std::ostream& os, XYZ const& xyz)
    {
        return os << std::to_string(xyz.x) + "/" + std::to_string(xyz.y) + "/" + std::to_string(xyz.z);
    }

Nstd::SafeIndexの開発」や「コンテナ用Nstd::operator<<の開発」 の成果物との組み合わせの単体テストは下記のように書けるだろう。

    //  example/template_cpp17/generic_lambda_ut.cpp 31

    auto v   = Nstd::SafeVector<XYZ>{{9, 8, 7}, {6, 5, 4}, {3, 2, 1}, {0, 1, 2}};
    auto oss = std::ostringstream{};

    oss << v;
    ASSERT_EQ("9/8/7, 6/5/4, 3/2/1, 0/1/2", oss.str());

std::sortによるソートができるかどうかのテストは、C++11までは、

    //  example/template_cpp17/generic_lambda_ut.cpp 41

    auto v = Nstd::SafeVector<XYZ>{{9, 8, 7}, {6, 5, 4}, {3, 2, 1}, {0, 1, 2}};

    // C++11 lambda                  型の明示が必要
    //                               ↓               ↓
    std::sort(v.begin(), v.end(), [](XYZ const& lhs, XYZ const& rhs) noexcept {
        return std::tie(lhs.x, lhs.y, lhs.z) < std::tie(rhs.x, rhs.y, rhs.z);
    });
    auto oss = std::ostringstream{};

    oss << v;
    ASSERT_EQ("0/1/2, 3/2/1, 6/5/4, 9/8/7", oss.str());

のように書くのが一般的だろう。ラムダ式の引数の型を指定しなければならないのは、 範囲for文でautoが使用出来ること等と比べると見劣りがするが、 C++14からは下記のコードで示した通り引数にautoが使えるようになった。

    //  example/template_cpp17/generic_lambda_ut.cpp 57

    auto v = Nstd::SafeVector<XYZ>{{9, 8, 7}, {6, 5, 4}, {3, 2, 1}, {0, 1, 2}};

    // C++14 generic lambda          型の明示が不要
    //                               ↓                ↓
    std::sort(v.begin(), v.end(), [](auto const& lhs, auto const& rhs) noexcept {
        return std::tie(lhs.x, lhs.y, lhs.z) < std::tie(rhs.x, rhs.y, rhs.z);
    });
    auto oss = std::ostringstream{};

    oss << v;
    ASSERT_EQ("0/1/2, 3/2/1, 6/5/4, 9/8/7", oss.str());

この記法はジェネリックラムダと呼ばれる。 この機能により関数の中で関数テンプレートと同等のものが定義できるようになった。

ジェネリックラムダの内部構造

ジェネリックラムダは下記のように使用することができる。

    //  example/template_cpp17/generic_lambda_ut.cpp 73

    template <typename PUTTO>
    void f(PUTTO&& p)
    {
        p(1);       // ラムダの引数elemの型はint
        p(2.71);    // ラムダの引数elemは型はdouble
        p("hehe");  // ラムダの引数elemは型はchar [5]
    }

    TEST(Template, generic_lambda)
    {
        auto oss = std::ostringstream{};

        f([&oss](auto const& elem) { oss << elem << std::endl; });

        ASSERT_EQ("1\n2.71\nhehe\n", oss.str());
    }

この例で使用しているクロージャは一見、型をダイナミックに扱っているように見えるが、 下記のような「テンプレートoperator()を持つ関数型」オブジェクトとして展開されていると考えれば、 理解できる。

    //  example/template_cpp17/generic_lambda_ut.cpp 92

    class Closure {
    public:
        Closure(std::ostream& os) : os_{os} {}

        template <typename T>
        void operator()(T&& t)
        {
            os_ << t << std::endl;
        }

    private:
        std::ostream& os_;
    };
    //  example/template_cpp17/generic_lambda_ut.cpp 111

    auto oss = std::ostringstream{};

    auto closure = Closure{oss};
    f(closure);

    ASSERT_EQ("1\n2.71\nhehe\n", oss.str());

std::variantとジェネリックラムダ

unionは、オブジェクトを全く無関係な複数の型に切り替えることができるため、 これが必要な場面では有用な機能であるが、未定義動作を誘発してしまう問題がある。 この対策としてC++17で導入されたものが、std::variantである。

まずは、std::variantの使用例を下記する。

    //  example/template_cpp17/variant_ut.cpp 13

    auto v = std::variant<int, std::string, double>{};  // 3つの型を切り替える

    // std::get<N>()の戻り値型は、下記の通りで、
    // N == 0, 1, 2 は、それぞれint, std::string, doubleに対応
    static_assert(std::is_same_v<decltype(std::get<0>(v)), int&>);
    static_assert(std::is_same_v<decltype(std::get<1>(v)), std::string&>);
    static_assert(std::is_same_v<decltype(std::get<2>(v)), double&>);

    v = int{3};  // int型の3を代入

    ASSERT_EQ(v.index(), 0);                                // intを保持
    ASSERT_EQ(std::get<0>(v), 3);                           // intなので問題なくアクセス
    ASSERT_THROW(std::get<1>(v), std::bad_variant_access);  // std::stringではないのでエクセプション
    ASSERT_THROW(std::get<2>(v), std::bad_variant_access);  // doubleではないのでエクセプション

    v = std::string{"str"};  // std::stringオブジェクトを代入

    ASSERT_EQ(v.index(), 1);                                // std::stringを保持
    ASSERT_THROW(std::get<0>(v), std::bad_variant_access);  // intではないのでエクセプション
    ASSERT_EQ(std::get<1>(v), std::string{"str"});          // std::stringなので問題なくアクセス
    ASSERT_THROW(std::get<2>(v), std::bad_variant_access);  // doubleではないのでエクセプション

上記からわかる通り、std::variantオブジェクトは、直前に代入されたオブジェクトの型以外で、 値を読み出した場合、問題なく読み出せるが、それ以外ではエクセプションを発生させる。

このstd::variantオブジェクトの保持する型とその値を文字列として取り出すラムダ式は、 下記のように書ける。

    //  example/template_cpp17/variant_ut.cpp 37

    auto oss = std::ostringstream{};

    // type_valueはvが保持する型をその値を文字列で返す
    auto type_value = [&oss](auto const& v) {  // ジェネリックラムダでなくても実装可能
        if (v.index() == 0) {
            auto a  = std::get<0>(v);
            using T = std::remove_const_t<std::remove_reference_t<decltype(a)>>;
            oss << Nstd::Type2Str<T>() << " : " << a;  // Nstd::Type2Str<T>はTの型を文字列にする
        }
        else if (v.index() == 1) {
            auto a  = std::get<1>(v);
            using T = std::remove_const_t<std::remove_reference_t<decltype(a)>>;
            oss << Nstd::Type2Str<T>() << " : " << a;  // Nstd::Type2Str<T>はTの型を文字列にする
        }
        else if (v.index() == 2) {
            auto a  = std::get<2>(v);
            using T = std::remove_const_t<std::remove_reference_t<decltype(a)>>;
            oss << Nstd::Type2Str<T>() << " : " << a;  // Nstd::Type2Str<T>はTの型を文字列にする
        }
        else {
            assert(false);  // ここには来ないはず
        }
    };

    v = 3;  // int型の3を代入
    type_value(v);
    ASSERT_EQ("int : 3", oss.str());
    oss = std::ostringstream{};  // ossのリセット

    v = std::string{"str"};  // std::stringオブジェクトを代入
    type_value(v);
    ASSERT_EQ("std::string : str", oss.str());
    oss = std::ostringstream{};  // ossのリセット

    v = 1.1;  // double型の1.1を代入
    type_value(v);
    ASSERT_EQ("double : 1.1", oss.str());

このラムダは、 3つの型をテンプレートパラメータとするstd::variantオブジェクト以外には適用できないため、 型の個数に制限のない方法を考える。

この実装は、

の2つによって下記のように行うことができる。

    //  example/template_cpp17/variant_ut.cpp 79

    template <typename VARIANT, typename F, size_t INDEX = 0>
    void org_visit(const F& f, const VARIANT& v)
    {
        constexpr auto n = std::variant_size_v<VARIANT>;

        if constexpr (INDEX < n) {
            if (v.index() == INDEX) {  // 保持する型が見つかった
                f(std::get<INDEX>(v));
                return;
            }
            else {  // 保持する型が見つかるまでリカーシブ
                org_visit<VARIANT, F, INDEX + 1>(f, v);
            }
        }
        else {
            assert(false);  // ここには来ないはず
        }
    }
    //  example/template_cpp17/variant_ut.cpp 103

    auto oss = std::ostringstream{};

    // 文字列を返すためのジェネリックラムダ
    auto type_value = [&oss](auto const& a) {
        using T = std::remove_const_t<std::remove_reference_t<decltype(a)>>;
        oss << Nstd::Type2Str<T>() << " : " << a;
    };

単体テストは、以下のようになる。

    //  example/template_cpp17/variant_ut.cpp 113
    {
        auto v = std::variant<int, std::string, double>{};  // 3つの型を切り替える

        v = 3;
        org_visit(type_value, v);
        ASSERT_EQ("int : 3", oss.str());
        oss = std::ostringstream{};  // ossのリセット

        // ...
    }
    {
        auto v = std::variant<char, int, std::string, double>{};  // 4つの型を切り替える

        v = 3;
        org_visit(type_value, v);
        ASSERT_EQ("int : 3", oss.str());
        oss = std::ostringstream{};  // ossのリセット

        v = 'c';
        org_visit(type_value, v);
        ASSERT_EQ("char : c", oss.str());
        oss = std::ostringstream{};  // ossのリセット

        // ...
    }

下記のように継承関係のない複数のクラスが同じシグネチャのメンバ関数を持つ場合、

    //  example/template_cpp17/variant_ut.cpp 177

    class A {
    public:
        char f() const noexcept { return 'A'; }
    };

    class B {
    public:
        char f() const noexcept { return 'B'; }
    };

    class C {
    public:
        char f() const noexcept { return 'C'; }
    };

std::variant、上に示した関数テンプレート、ジェネリックラムダを使い、 下記に示したような疑似的なポリモーフィズムを実現できる。

    //  example/template_cpp17/variant_ut.cpp 197

    char ret{};
    auto call_f = [&ret](auto const& a) { ret = a.f(); };

    auto v = std::variant<A, B, C>{};

    org_visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('A', ret);

    v = B{};
    org_visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('B', ret);

    v = C{};
    org_visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('C', ret);

ここで示した関数テンプレートは、デザインパターンVisitorの例であり、 ほぼこれと同様のものがstd::visitとして定義されている。

    //  example/template_cpp17/variant_ut.cpp 215

    v = A{};
    std::visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('A', ret);

    v = B{};
    std::visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('B', ret);

    v = C{};
    std::visit(call_f, v);  // 疑似的なポリモーフィズム
    ASSERT_EQ('C', ret);

クラステンプレートと継承の再帰構造

クラステンプレートと継承の再帰構造はCRTPと呼ばれる。 このコードパターンについては、 「CRTP(curiously recurring template pattern)」で説明している。

意図しないname lookupの防止

下記のようにクラスや関数テンプレートが定義されている場合を考える。

    //  example/template_cpp17/suppress_adl_ut.cpp 11

    namespace App {

    struct XY {
        int x;
        int y;
    };

    // このような関数テンプレートは適用範囲が広すぎるので定義すべきではないが、
    // 危険な例を示すためあえて定義している
    template <typename T, typename U>
    inline auto is_equal(T const& lhs, U const& rhs) noexcept -> decltype(lhs.x == rhs.x, lhs.y == rhs.y)
    {
        return lhs.x == rhs.x && lhs.y == rhs.y;
    }
    }  // namespace App

これに対しての単体テストは下記のようになる。

    //  example/template_cpp17/suppress_adl_ut.cpp 36

    auto xy0 = App::XY{0, 1};
    auto xy1 = App::XY{0, 2};
    auto xy2 = App::XY{0, 1};

    ASSERT_FALSE(is_equal(xy0, xy1));
    ASSERT_TRUE(is_equal(xy0, xy2));

    struct point {
        int x;
        int y;
    };
    auto p0 = point{0, 1};

    // 下記のような比較ができるようにするためis_equalはテンプレートで実装している
    ASSERT_TRUE(is_equal(p0, xy0));
    ASSERT_FALSE(is_equal(p0, xy1));

上記の抜粋である

    //  example/template_cpp17/suppress_adl_ut.cpp 42

    ASSERT_FALSE(is_equal(xy0, xy1));
    ASSERT_TRUE(is_equal(xy0, xy2));

が名前空間Appの指定なしでコンパイルできる理由は、 ADL(実引数依存探索)により、Appもis_equalのname lookupの対象になるからである。 これは便利な機能であるが、その副作用として意図しないname lookupによるバグの混入を起こしてしまうことがある。

上記の名前空間での定義が可視である状態で、下記のようなコードを書いた場合を考える。

    //  example/template_cpp17/suppress_adl_ut.cpp 62

    namespace App2 {
    struct XYZ {
        int x;
        int y;
        int z;
    };

    inline bool is_equal(XYZ const& lhs, XYZ const& rhs) noexcept
    {
        return lhs.x == rhs.x && lhs.y == rhs.y && lhs.z == rhs.z;
    }
    }  // namespace App2

この単体テストは、やはりADLを使い下記のように書ける。

    //  example/template_cpp17/suppress_adl_ut.cpp 83
    auto xyz0 = App2::XYZ{0, 2, 2};
    auto xyz1 = App2::XYZ{0, 1, 2};

    ASSERT_TRUE(is_equal(xyz0, xyz0));
    ASSERT_FALSE(is_equal(xyz0, xyz1));

これに問題はないが、下記のテストもコンパイルでき、且つテストもパスしてしまうことには問題がある。

    //  example/template_cpp17/suppress_adl_ut.cpp 92

    auto xyz0 = App2::XYZ{0, 2, 2};
    auto xyz1 = App2::XYZ{0, 1, 2};
    auto xy0  = App::XY{0, 1};

    ASSERT_FALSE(is_equal(xy0, xyz0));  // これがコンパイルできてしまう
    ASSERT_TRUE(is_equal(xy0, xyz1));   // このis_equalはAppで定義されたもの

このセマンティクス的に無意味な(もしくは混乱を引き起こしてしまうであろう)コードは、

というメカニズムによりコンパイルできてしまう。

こういったname lookup、特にADLの問題に対処する方法は、

のようにいくつか考えられる。これらについて以下で説明を行う。

ジェネリックすぎるテンプレートを書かない

ここでの「ジェネリックすぎるテンプレート」とは、 シンタックス的には適用範囲が広いにもかかわらず、セマンティクス的な適用範囲は限られているものを指す。 従って下記のような関数テンプレートを指す概念ではない。

    //  example/template_cpp17/suppress_adl_ut.cpp 107

    template <typename T, size_t N>
    constexpr auto array_length(T const (&)[N]) noexcept
    {
        return N;
    }

前記で問題を起こした関数テンプレート

    //  example/template_cpp17/suppress_adl_ut.cpp 20

    // このような関数テンプレートは適用範囲が広すぎるので定義すべきではないが、
    // 危険な例を示すためあえて定義している
    template <typename T, typename U>
    inline auto is_equal(T const& lhs, U const& rhs) noexcept -> decltype(lhs.x == rhs.x, lhs.y == rhs.y)
    {
        return lhs.x == rhs.x && lhs.y == rhs.y;
    }
    }  // namespace App

が典型的な「ジェネリックすぎるテンプレート」である。 これに対する最も安全な対処は下記コードで示す通りテンプレートを使わないことである。

    //  example/template_cpp17/suppress_adl_ut.cpp 125

    namespace App {

    struct XY {
        int x;
        int y;
    };

    inline bool is_equal(XY const& lhs, XY const& rhs) noexcept { return lhs.x == rhs.x && lhs.y == rhs.y; }
    }  // namespace App

ジェネリックなis_equalが必要であれば下記単体テストのように ジェネリックラムダによる関数内での関数テンプレートの定義を行えばよい。 こうすることでその適用範囲はそれを定義した関数内に留まる。

    //  example/template_cpp17/suppress_adl_ut.cpp 149

    // 下記のpointのようなクラスが他にもいくつかあった場合、
    // このジェネリックラムダでコードの被りは回避できる
    auto is_equal = [](auto const& lhs, auto const& rhs) noexcept { return lhs.x == rhs.x && lhs.y == rhs.y; };

    struct point {
        int x;
        int y;
    };
    auto p0 = point{0, 1};

    ASSERT_TRUE(is_equal(p0, xy0));
    ASSERT_FALSE(is_equal(p0, xy1));

上記で示した

といった方法の他にも、「コンテナ用Nstd::operator<<の開発」で示した

ことも考えられる。 ベストな方法は状況に大きく依存するため一概には決められない。 その状況でのもっとも単純は方法を選ぶべきだろう(が、何が単純かも一概に決めることは難しい)。

ADLが本当に必要でない限り名前を修飾する

下記のコードについて考える。

    //  example/template_cpp17/suppress_adl_ut.cpp 170

    struct A {
        int f(int i) noexcept { return i * 3; }
    };

    int f(int i) noexcept { return i * 2; }

    namespace App {

    template <typename T>
    class ExecF : public T {
    public:
        int operator()(int i) noexcept
        {
            return f(i);  // T::fの呼び出しにも見えるが、::fの呼び出し
        }

        // Tを使ったコード
        // ...
    };
    }  // namespace App

基底クラスのメンバ関数を呼び出す場合は、T::f()、もしくは、this->f()と書く必要があるため、 下記コードで呼び出した関数fは外部関数fの呼び出しになる (two phase name lookupの一回目のname lookupでfがバインドされるため)。

    //  example/template_cpp17/suppress_adl_ut.cpp 197

    auto ef = App::ExecF<A>{};

    ASSERT_EQ(4, ef(2));  // ::fの呼び出しなので、2 * 2 == 4となる

これだけでも十分わかりづらいが、 ExecFのテンプレートパラメータにはクラスAしか使われないことがわかったので、 下記のようにリファクタリングしたとしよう。

    //  example/template_cpp17/suppress_adl_ut.cpp 207

    struct A {
        int f(int i) noexcept { return i * 3; }
    };

    int f(int i) noexcept { return i * 2; }

    namespace App {

    class ExecF : public A {
    public:
        int operator()(int i) noexcept { return f(i); }

        // Tを使ったコード
        // ...
    };
    }  // namespace App

すると、fのname lookupの対象が変わってしまい、元の単体テストはパスしなくなる。

    //  example/template_cpp17/suppress_adl_ut.cpp 230

    auto ef = App::ExecF{};

    // ASSERT_EQ(4, ef(2));
    ASSERT_EQ(6, ef(2));  // リファクタリングでname lookupの対象が変わり、A::fが呼ばれる

こういった場合に備え単体テストを実行すべきなのだが、この程度の問題はコンパイルで検出したい。 ADLtwo phase name lookupが絡む場合ならなおさらである。

こういう意図しないname lookupに備えるためには、 修飾されていない識別子を使わないこと、つまり、 識別子には、名前空間、クラス名、this->等による修飾を施すことが重要である。

ただし、「コンテナ用Nstd::operator<<の開発」で示したコード等にはADLが欠かせないため、 修飾することをルール化することはできない。場合に合わせた運用が唯一の解となる。

ADL Firewallを使う

下記のコードについて考える。

    //  example/template_cpp17/adl_firewall_0_ut.cpp 10

    namespace App {

    template <typename T>
    std::string ToString(std::vector<T> const& t)
    {
        auto oss = std::ostringstream{};

        using Nstd::operator<<;
        oss << t;  // Nstd::operator<<もname lookupの対象に含める

        return oss.str();
    }
    }  // namespace App

    // ...

    namespace App {
    struct XY {
        XY(int ax, int ay) noexcept : x{ax}, y{ay} {}
        int x;
        int y;
    };

    std::ostream& operator<<(std::ostream& os, XY const& xyz)
    {
        return os << std::to_string(xyz.x) + "/" + std::to_string(xyz.y);
    }
    }  // namespace App

上記のApp::ToStringは「コンテナ用Nstd::operator<<の開発」のコードを使用し、 std::vectorオブジェクトをstd::stringに変換する。

これに対しての単体テストは下記のようになる。

    //  example/template_cpp17/adl_firewall_0_ut.cpp 47

    auto xys = std::vector<App::XY>{{9, 8}, {7, 6}};

    ASSERT_EQ("9/8, 7/6", App::ToString(xys));

これは想定通りの動作だが、上記のAppの後に下記のコードを追加するとApp::ToStringは影響を受ける。

    //  example/template_cpp17/adl_firewall_1_ut.cpp 40

    // Appに下記を追加
    namespace App {
    template <typename T>
    std::ostream& operator<<(std::ostream& os, std::vector<T> const& t)
    {
        return os << "size:" << t.size();
    }
    }  // namespace App

これにより元の単体テストはエラーとなり、新しい単体テストは下記のようになる。

    //  example/template_cpp17/adl_firewall_1_ut.cpp 56

    auto xys = std::vector<App::XY>{{9, 8}, {7, 6}};

    // App::operator<<の追加で、App::ToStringの出力が影響を受ける
    // ASSERT_EQ("9/8, 7/6", App::ToString(xys));
    ASSERT_EQ("size:2", App::ToString(xys));

これが意図通りなら問題ないが、 ここでは「新たに追加した関数テンプレートApp::operator<<はstd::vector<App::XY>用ではなかった」 としよう。その場合、これは意図しないADLによるバグの混入となる。 「ジェネリックすぎるテンプレートを書かない」 で述べたように追加した関数テンプレートの適用範囲が広すぎることが原因であるが、 XY型から生成されたオブジェクト(std::vector<App::XY>も含む)によるADLのため、 Appの宣言がname lookupの対象になったことにも原因がある。

下記のコードは後者の原因を解消する。

    //  example/template_cpp17/adl_firewall_2_ut.cpp 23

    // Appの中の新たな名前空間XY_Firewall_でstruct XYとoperator<<を宣言
    namespace App {
    namespace XY_Firewall_ {

    struct XY {
        XY(int ax, int ay) noexcept : x{ax}, y{ay} {}
        int x;
        int y;
    };

    std::ostream& operator<<(std::ostream& os, XY const& xyz)
    {
        return os << std::to_string(xyz.x) + "/" + std::to_string(xyz.y);
    }
    }  // namespace XY_Firewall_

    using XY = XY_Firewall_::XY;

    }  // namespace App

XY型オブジェクトを引数にした関数呼び出しによる関連名前空間は、 極小なApp::XY_Firewall_であるため、意図しないADLは起こりづらく、起こっても発見しやすい。 また、XY型用operator<<もApp::XY_Firewall_で定義し、 App内でusing XYを宣言したことで、これまで通りApp::XYが使える。

このようなテクニックをADL firewallと呼ぶ。

Nstd::Type2Strの開発

Nstdライブラリの開発」等で行ったメタ関数の実装は、

等によるコンパイルエラーとの戦いである。 また、これをクリアしてもtwo phase name lookupADLが次の関門になる。 これには、デバッガのステップ実行が強力な武器となるが、 型を文字列に変換する関数があればこれもまた強力な武器となる。

以下に示すNstd::Type2Strは、「Nstdライブラリの開発」等で実際に使用したそのような関数である。

    //  h/nstd_type2str.h 9

    namespace Nstd {
    namespace Inner_ {

    inline std::string demangle(char const* to_demagle)
    {
        int status;

        auto demangled
            = std::unique_ptr<char, decltype(&std::free)>{abi::__cxa_demangle(to_demagle, 0, 0, &status), &std::free};

        return demangled.get();
    }

    template <typename>  // typenameを取り出すためだけのクラステンプレート
    struct type_capture {
    };
    }  // namespace Inner_

    template <typename T>
    std::string Type2Str()
    {
        // typeid(T)とした場合、const/volatile/&の情報が捨てられるため、
        // typeid(type_capture<T>)とし、それを防ぐ。
        auto str = std::string{Inner_::demangle(typeid(Inner_::type_capture<T>).name())};

        // T   == const int ならば、
        // str == Nstd::Inner_::type_capture<int const>
        //        <----------- 27 ----------><-- x --> 下記ではxを切り出す
        constexpr auto beg  = 27U;                                    // 先頭の不要な文字列数
        auto           name = str.substr(beg, str.size() - beg - 1);  // 最後の文字は>なので不要

        while (name.back() == ' ') {  // 無駄なスペースを消す
            auto last = --name.end();
            name.erase(last);
        }

        return name;
    }
    }  // namespace Nstd

typeid::name()が返す文字列リテラルは引数の型の文字列表現を持つが、 マングリングされているためヒューマンリーダブルではない。 それをデマングルするのがabi::__cxa_demangleであるが、 残念なことにこの関数は非標準であるため、 それを使っているNstd::Inner_::demangleはg++/clang++ でなければコンパイルできないだろう。

それを除けば、 複雑なシンタックスを持つ型を文字列で表現できるNstd::Type2Strは、 テンプレートプログラミングおける有効なデバッグツールであると言える。

下記単体テストは、そのことを示している。

    //  example/template/nstd_type2str_ut.cpp 11

    ASSERT_EQ("int const", Nstd::Type2Str<int const>());
    ASSERT_EQ("std::string", Nstd::Type2Str<std::string>());
    ASSERT_EQ("std::vector<int, std::allocator<int> >", Nstd::Type2Str<std::vector<int>>());

    extern void f(int);
    ASSERT_EQ("void (int)", Nstd::Type2Str<decltype(f)>());  // 関数の型

    auto lamda = []() noexcept {};
    ASSERT_NE("", Nstd::Type2Str<decltype(lamda)>());  // XXX::{lambda()#1}な感じになる

    ASSERT_EQ("std::ostream& (std::ostream&, int const (&) [3])",
              Nstd::Type2Str<decltype(Nstd::operator<< <int[3]>)>());

    // std::declvalはrvalueリファレンスを返す
    ASSERT_EQ("int (&&) [3]", Nstd::Type2Str<decltype(std::declval<int[3]>())>());

    int i3[3];
    ASSERT_EQ("int [3]", Nstd::Type2Str<decltype(i3)>());
    ASSERT_EQ("int (&) [3]", Nstd::Type2Str<decltype((i3))>());  // (i3)はlvalueリファレンス

    auto& r = i3;
    ASSERT_EQ("int (&) [3]", Nstd::Type2Str<decltype(r)>());

静的な文字列オブジェクト

std::stringは文字列を扱うことにおいて、非常に有益なクラスではあるが、 コンパイル時に文字列が決定できる場合でも、動的にメモリを確保する。

この振る舞いは、

    //  example/template_cpp17/nstd_exception_ut.cpp 6

    class Exception : std::exception {
    public:
        Exception(char const* filename, uint32_t line_num, char const* msg)
            : what_str_{std::string{filename} + ":" + std::to_string(line_num) + ":" + msg}
        {
        }

        char const* what() const noexcept override { return what_str_.c_str(); }

    private:
        std::string what_str_;
    };

    int32_t div(int32_t a, int32_t b)
    {
        if (b == 0) {
            throw Exception{__FILE__, __LINE__, "divided by 0"};  // 24行目
        }

        return a / b;
    }
    //  example/template_cpp17/nstd_exception_ut.cpp 34

    auto caught = false;
    try {
        div(1, 0);
    }
    catch (Exception const& e) {
        ASSERT_STREQ("nstd_exception_ut.cpp:24:divided by 0", e.what());
        caught = true;
    }
    ASSERT_TRUE(caught);

このような問題を回避するために、ここでは静的に文字列を扱うためのクラスStaticStringを開発する。

StaticStringのヘルパークラスの開発

StaticStringオブジェクトは、char配列をメンバとして持つが、 コンパイル時に解決できる配列の初期化にはパラメータパックが利用できる。 そのパラメータパック生成クラスを下記のように定義する。

    //  example/template_cpp17/nstd_seq.h 4

    // パラメータパック展開ヘルパクラス
    template <size_t... Ns>
    struct index_sequence {
    };

    // index_sequence<0, 1, 2, ...>を作るためのクラステンプレート
    // make_index_sequence<3>
    // -> make_index_sequence<2, 2>
    // -> make_index_sequence<1, 1, 2>
    // -> make_index_sequence<0, 0, 1, 2>
    // -> index_sequence<0, 1, 2>
    template <size_t N, size_t... Ns>
    struct make_index_sequence : make_index_sequence<N - 1, N - 1, Ns...> {
    };

    template <size_t... Ns>
    struct make_index_sequence<0, Ns...> : index_sequence<Ns...> {
    };

このクラスにより、下記のような配列メンバの初期ができるようになる。

    //  example/template_cpp17/nstd_seq_ut.cpp 7

    template <size_t N>
    struct seq_test {
        template <size_t... S>
        constexpr seq_test(index_sequence<S...>) noexcept : data{S...}
        {
        }
        int const data[N];
    };
    //  example/template_cpp17/nstd_seq_ut.cpp 24

    constexpr auto st = seq_test<3>{index_sequence<1, 2, 3>()};
    ASSERT_EQ(1, st.data[0]);
    ASSERT_EQ(2, st.data[1]);
    ASSERT_EQ(3, st.data[2]);

これを下記のように使うことで、メンバである文字列配列のコンパイル時初期化ができるようになる。

    //  example/template_cpp17/nstd_seq_ut.cpp 33

    template <size_t N>
    class seq_test2 {
    public:
        template <size_t... S>
        constexpr seq_test2(char const (&str)[N], index_sequence<S...>) noexcept : string_{str[S]...}
        {
        }

        constexpr char const (&String() const noexcept)[N] { return string_; }

    private:
        char const string_[N];
    };
    //  example/template_cpp17/nstd_seq_ut.cpp 52

    constexpr char const str[]{"123"};

    constexpr auto st = seq_test2<4>{str, index_sequence<0, 1, 2>()};
    ASSERT_STREQ("123", st.String());

    constexpr auto st2 = seq_test2<4>{str, make_index_sequence<sizeof(str) - 1>()};
    ASSERT_STREQ("123", st2.String());

上記とほぼ同様のクラステンプレートstd::index_sequence、std::make_index_sequenceが、 utilityで定義されているため、以下ではこれらを使用する。

StaticStringの開発

StaticStringはすでに示したテクニックを使い、下記のように定義できる。

    //  example/h/nstd_static_string.h 10

    template <size_t N>
    class StaticString {
    public:
        constexpr StaticString(char const (&str)[N]) noexcept : StaticString{0, str, std::make_index_sequence<N - 1>{}} {}

        template <size_t M>
        constexpr StaticString(size_t offset, StaticString<M> ss) noexcept
            : StaticString{offset, ss.string_, std::make_index_sequence<N - 1>{}}
        {
        }

        constexpr StaticString(std::initializer_list<char> args) noexcept
            : StaticString{0, args, std::make_index_sequence<N - 1>{}}
        {
        }

        constexpr char const (&String() const noexcept)[N] { return string_; }
        constexpr size_t Size() const noexcept { return N; }

    private:
        char const string_[N];

    #if __cplusplus >= 202002L  // c++20
        template <Beginable T, size_t... I>
    #else  // c++17
        template <typename T, size_t... I>
    #endif
        // offsetは部分StaticString切り出しのため(TopStr, BottomStr)
        constexpr StaticString(size_t offset, T& t, std::index_sequence<I...>) noexcept
            : string_{std::begin(t)[I + offset]...}
        {
        }

        template <size_t M>
        friend class StaticString;
    };

文字列リテラルからStaticStringを生成する単体テストは下記のようになる。

    //  example/template_cpp17/nstd_static_string_ut.cpp 12

    const auto fs = StaticString{"abc"};  // C++17からのNの指定は不要

    static_assert(sizeof(4) == fs.Size());
    ASSERT_STREQ("abc", fs.String());

    // 文字列不足であるため、下記はコンパイルさせない
    // constexpr StaticString<4> fs2{"ab"};

また、std::initializer_list<char>による初期化の単体テストは下記のようになる。

    //  example/template_cpp17/nstd_static_string_ut.cpp 24

    const auto fs = StaticString<4>{'a', 'b', 'c'};  // C++17でもNの指定は必要

    static_assert(sizeof(4) == fs.Size());
    ASSERT_STREQ("abc", fs.String());

    // 文字列不足であるため、下記はコンパイルさせない
    // constexpr StaticString<4> fs2{'a', 'b'};

次にこのクラスにc++17用にoperator==とc++20用にoperator<=>を追加する。

    //  example/h/nstd_static_string.h 49

    namespace Inner_ {
    template <size_t N>
    constexpr bool equal_n(size_t n, StaticString<N> const& lhs, StaticString<N> const& rhs) noexcept
    {
        if (n == N) {
            return true;
        }
        else {
            return lhs.String()[n] != rhs.String()[n] ? false : equal_n(n + 1, lhs, rhs);
        }
    }
    }  // namespace Inner_

    #if __cplusplus <= 201703L  // c++17
    template <size_t N1, size_t N2>
    constexpr bool operator==(StaticString<N1> const&, StaticString<N2> const&) noexcept
    {
        return false;
    }

    template <size_t N1, size_t N2>
    constexpr bool operator!=(StaticString<N1> const& lhs, StaticString<N2> const& rhs) noexcept
    {
        return !(lhs == rhs);
    }

    template <size_t N>
    constexpr bool operator==(StaticString<N> const& lhs, StaticString<N> const& rhs) noexcept
    {
        return Inner_::equal_n(0, lhs, rhs);
    }

    template <size_t N>
    constexpr bool operator!=(StaticString<N> const& lhs, StaticString<N> const& rhs) noexcept
    {
        return !(lhs == rhs);
    }

    template <size_t N1, size_t N2>
    constexpr bool operator==(StaticString<N1> const& lhs, char const (&rhs)[N2]) noexcept
    {
        return lhs == StaticString{rhs};
    }

    template <size_t N1, size_t N2>
    constexpr bool operator!=(StaticString<N1> const& lhs, char const (&rhs)[N2]) noexcept
    {
        return !(lhs == rhs);
    }

    template <size_t N1, size_t N2>
    constexpr bool operator==(char const (&lhs)[N1], StaticString<N2> const& rhs) noexcept
    {
        return StaticString{lhs} == rhs;
    }

    template <size_t N1, size_t N2>
    constexpr bool operator!=(char const (&lhs)[N1], StaticString<N2> const& rhs) noexcept
    {
        return !(lhs == rhs);
    }
    #elif __cplusplus >= 202002L  // c++20
    // 以下、operator==とoperator!=を<=>に置き換え
    template <size_t N1, size_t N2>
    constexpr auto operator<=>(StaticString<N1> const& lhs, StaticString<N2> const& rhs) noexcept
    {
        if constexpr (N1 != N2) {
            return N1 <=> N2;  // サイズが異なる場合は直接サイズを比較
        }
        else {
            return std::lexicographical_compare_three_way(lhs.String(), lhs.String() + N1 - 1, rhs.String(),
                                                          rhs.String() + N2 - 1);
        }
    }

    template <size_t N1, size_t N2>
    constexpr auto operator<=>(StaticString<N1> const& lhs, char const (&rhs)[N2]) noexcept
    {
        return lhs <=> StaticString{rhs};
    }

    template <size_t N1, size_t N2>
    constexpr auto operator<=>(char const (&lhs)[N1], StaticString<N2> const& rhs) noexcept
    {
        return StaticString{lhs} <=> rhs;
    }

    // operator==は明示的に定義する必要がある(<=>からは自動生成されない)
    template <size_t N1, size_t N2>
    constexpr bool operator==(StaticString<N1> const& lhs, StaticString<N2> const& rhs) noexcept
    {
        return (lhs <=> rhs) == 0;
    }

    template <size_t N1, size_t N2>
    constexpr bool operator==(StaticString<N1> const& lhs, char const (&rhs)[N2]) noexcept
    {
        return lhs == StaticString{rhs};
    }

    template <size_t N1, size_t N2>
    constexpr bool operator==(char const (&lhs)[N1], StaticString<N2> const& rhs) noexcept
    {
        return StaticString{lhs} == rhs;
    }
    #endif

単体テストは下記のようになる。

    //  example/template_cpp17/nstd_static_string_ut.cpp 70

    static_assert(StaticString{"123"} == StaticString{"123"});
    static_assert(StaticString{"123"} != StaticString{"1234"});
    static_assert(StaticString{"123"} == "123");
    static_assert("123" == StaticString{"123"});
    static_assert(StaticString{"123"} != "1234");
    static_assert("1234" != StaticString{"123"});

暗黙の型変換を利用した文字列リテラルからStaticStringオブジェクトへの変換は、 StaticStringがテンプレートであるため機能せず、上記のように書く必要がある。

同様にoperator + を追加する。

    //  example/h/nstd_static_string.h 158

    namespace Inner_ {
    template <size_t N1, size_t... I1, size_t N2, size_t... I2>
    constexpr StaticString<N1 + N2 - 1> concat(char const (&str1)[N1], std::index_sequence<I1...>, char const (&str2)[N2],
                                               std::index_sequence<I2...>) noexcept
    {
        return {str1[I1]..., str2[I2]...};
    }
    }  // namespace Inner_

    template <size_t N1, size_t N2>
    constexpr auto operator+(StaticString<N1> const& lhs, StaticString<N2> const& rhs) noexcept
    {
        return Inner_::concat(lhs.String(), std::make_index_sequence<N1 - 1>{}, rhs.String(),
                              std::make_index_sequence<N2>{});
    }

    template <size_t N1, size_t N2>
    constexpr auto operator+(StaticString<N1> const& lhs, char const (&rhs)[N2]) noexcept
    {
        return lhs + StaticString{rhs};
    }

    template <size_t N1, size_t N2>
    constexpr auto operator+(char const (&lhs)[N1], StaticString<N2> const& rhs) noexcept
    {
        return StaticString{lhs} + rhs;
    }
    //  example/template_cpp17/nstd_static_string_ut.cpp 83

    constexpr auto fs0 = StaticString{"1234"} + StaticString{"567"};
    static_assert(std::is_same_v<StaticString<fs0.Size()> const, decltype(fs0)>);
    static_assert("1234567" == fs0);

    constexpr auto fs1 = StaticString{"1234"} + ":";
    static_assert(std::is_same_v<StaticString<fs1.Size()> const, decltype(fs1)>);
    static_assert("1234:" == fs1);

    constexpr auto fs2 = ":" + StaticString{"567"};
    static_assert(std::is_same_v<StaticString<fs2.Size()> const, decltype(fs2)>);
    static_assert(":567" == fs2);

    constexpr auto fs3 = StaticString{"1234"} + ":" + StaticString{"567"};
    static_assert(std::is_same_v<StaticString<fs3.Size()> const, decltype(fs3)>);
    static_assert("1234:567" == fs3);

以上でstd::stringのように=、==、+などの演算が可能となった。 さらに下記の関数を追加することで、任意の位置、 任意のサイズの文字列を切り出せるようにすることでStaticStringはより便利に使用できるようになる。

    //  example/h/nstd_static_string.h 188

    template <size_t SIZE, size_t N>  // StaticString<SiZE>の部分文字列生成
    constexpr auto TopStr(StaticString<N> ss) noexcept
    {
        return StaticString<SIZE + 1>{0, ss};  // SIZE文字 + 終端文字
    }

    template <size_t OFFSET, size_t N>  // 先頭からオフセット2文字~終端文字まで
    constexpr auto BottomStr(StaticString<N> ss) noexcept
    {
        return StaticString<N - OFFSET>{OFFSET, ss};
    }
    //  example/template_cpp17/nstd_static_string_ut.cpp 53

    constexpr auto ss  = StaticString{"0123456789"};
    auto           ss2 = TopStr<2>(ss);  // 先頭2文字
    static_assert(3 == ss2.Size());      // 先頭2文字 + 終端文字
    ASSERT_STREQ("01", ss2.String());

    auto ss8 = BottomStr<2>(ss);     // 先頭からオフセット2文字~終端文字まで
    static_assert(9 == ss8.Size());  // 先頭からオフセット2文字~終端文字までは結果的に9文字
    ASSERT_STREQ("23456789", ss8.String());

    ASSERT_EQ(ss2 + ss8, ss);  // 元に戻す。+、= が使用される。

整数をStaticStringに変換する関数の開発

コンパイル時に__LINE__をStaticStringに変換できれば、 ファイル位置をStaticStringで表現できるため、 ここではその変換関数Int2StaticString<>()の実装を行う。

行番号を10進数での文字列で表現するため、いくつかのヘルパ関数を下記のように定義する。

    //  example/h/nstd_static_string_num.h 8

    namespace Inner_ {

    // 10進数桁数を返す
    constexpr size_t num_of_digits(size_t n) noexcept { return n > 0 ? 1 + num_of_digits(n / 10) : 0; }

    // 10のn乗を返す
    constexpr uint32_t ten_to_nth_power(uint32_t n) noexcept { return n == 0 ? 1 : 10 * ten_to_nth_power(n - 1); }

    // 10進数の桁の若い順番に左から並べなおす(12345 -> 54321)
    constexpr uint32_t reverse_num(uint32_t num) noexcept
    {
        return num != 0 ? (num % 10) * ten_to_nth_power(num_of_digits(num) - 1) + reverse_num(num / 10) : 0;
    }

    // 10進数一桁をacsii文字に変換
    constexpr char digit_to_char(uint32_t num, uint32_t n_th) noexcept
    {
        return '0' + (num % (ten_to_nth_power(n_th + 1))) / ten_to_nth_power(n_th);
    }

    // Int2StaticStringのヘルパ関数
    template <size_t N, size_t... Cs>
    constexpr StaticString<num_of_digits(N) + 1> make_static_string(std::index_sequence<Cs...>) noexcept
    {
        return {digit_to_char(reverse_num(N), Cs)...};
    }
    }  // namespace Inner_

単体テストは下記のようになる。

    //  example/template/nstd_static_string_num_ut.cpp 47

    constexpr auto ns       = make_static_string<__LINE__>(std::make_index_sequence<Inner_::num_of_digits(__LINE__)>());
    auto           line_num = __LINE__ - 1;

    ASSERT_EQ(std::to_string(line_num), ns.String());

このままでは使いづらいため、これをラッピングした関数を下記のように定義することで、 Int2StaticString<>()が得られる。

    //  example/h/nstd_static_string_num.h 38

    template <size_t N>
    constexpr StaticString<Inner_::num_of_digits(N) + 1> Int2StaticString() noexcept
    {
        return Inner_::make_static_string<N>(std::make_index_sequence<Inner_::num_of_digits(N)>());
    }

単体テストは下記のようになる。

    //  example/template/nstd_static_string_num_ut.cpp 65

    constexpr auto ns       = Int2StaticString<__LINE__>();
    auto           line_num = __LINE__ - 1;

    ASSERT_EQ(std::to_string(line_num), ns.String());

ファイル位置を静的に保持したエクセプションクラスの開発

静的な文字列オブジェクト」で見たように、 ファイル位置を動的に保持するエクセプションクラスは使い勝手が悪い。 ここでは、その問題を解決するためのExceptionクラスの実装を示す。

    //  example/h/nstd_exception.h 11

    /// @class Exception
    /// @brief StaticString<>を使ったエクセプションクラス
    ///        下記のMAKE_EXCEPTIONを使い生成
    /// @tparam E   std::exceptionから派生したエクセプションクラス
    /// @tparam N   StaticString<N>
    template <typename E, size_t N>
    #if __cplusplus >= 202002L  // c++20
    requires std::derived_from<E, std::exception>
    #endif
    class Exception : public E {
    public:
        static_assert(std::is_base_of_v<std::exception, E>);

        Exception(StaticString<N> const& what_str) noexcept : what_str_{what_str} {}
        char const* what() const noexcept override { return what_str_.String(); }

    private:
        StaticString<N> const what_str_;
    };

StaticStringと同様に、このままでは不便であるため、下記の関数を定義する。

    //  example/h/nstd_exception.h 33

    namespace Inner_ {
    template <typename E, template <size_t> class STATIC_STR, size_t N>
    #if __cplusplus >= 202002L  // c++20
    requires std::derived_from<E, std::exception>
    #endif
    auto make_exception(STATIC_STR<N> exception_str) noexcept { return Exception<E, N>{exception_str}; }
    }  // namespace Inner_

    template <typename E, size_t LINE_NUM, size_t F_N, size_t M_N>
    #if __cplusplus >= 202002L  // c++20
    requires std::derived_from<E, std::exception>
    #endif
    auto MakeException(char const (&filename)[F_N], char const (&msg)[M_N]) noexcept
    {
        return Inner_::make_exception<E>(StaticString{filename} + ":" + Int2StaticString<LINE_NUM>() + ":" + msg);
    }

単体テストは下記のようになる。

    //  example/template_cpp17/nstd_exception_ut.cpp 89

    auto caught   = false;
    auto line_num = __LINE__ + 2;  // 2行下の行番号
    try {
        throw MakeException<std::exception, __LINE__>(__FILE__, "some error message");
    }
    catch (std::exception const& e) {
        auto oss = std::ostringstream{};
        oss << __FILE__ << ":" << line_num << ":some error message";

        ASSERT_EQ(oss.str(), e.what());
        caught = true;
    }

    ASSERT_TRUE(caught);

Exceptionクラスの利便性をさらに高めるため、下記の定義を行う。

    //  example/h/nstd_exception.h 54

    #define MAKE_EXCEPTION(E__, msg__) Nstd::MakeException<E__, __LINE__>(__FILE__, msg__)

上記は、関数型マクロの数少ない使いどころである。

単体テストは下記のようになる。

    //  example/template_cpp17/nstd_exception_ut.cpp 109

    uint32_t line_num_div;  // エクセプション行を指定

    int32_t div(int32_t a, int32_t b)
    {
        if (b == 0) {
            line_num_div = __LINE__ + 1;  // 次の行番号
            throw MAKE_EXCEPTION(std::exception, "divided by 0");
        }

        return a / b;
    }
    //  example/template_cpp17/nstd_exception_ut.cpp 126

    auto caught = false;

    try {
        div(1, 0);
    }
    catch (std::exception const& e) {  // リファレンスでcatchしなければならない
        auto oss = std::ostringstream{};
        oss << __FILE__ << ":" << line_num_div << ":divided by 0";
        ASSERT_EQ(oss.str(), e.what());
        caught = true;
    }

    ASSERT_TRUE(caught);

関数型をテンプレートパラメータで使う

ここで使う「関数型」とは、

の総称を指す。

std::unique_ptrは、

を取ることができるが、通常は第2パラメータは省略される。 省略時にはstd::default_deleteが割り当てられ、そのオブジェクトによって、 第1パラメータに対応するポインタがdeleteされる。

下記コードではこの第2パラメータにstd::freeのポインタの型を与え、 それから生成されるstd::unique_ptrオブジェクトを、

で初期化することでメモリの解放を行っている。

    //  h/nstd_type2str.h 18

    auto demangled
        = std::unique_ptr<char, decltype(&std::free)>{abi::__cxa_demangle(to_demagle, 0, 0, &status), &std::free};

std::unique_ptrの第2パラメータには、上記のような関数へのポインタのみではなく、 関数型を取ることができる。

そのことを順を追って示す。 まずは、std::unique_ptrの動作を確かめるためのクラスを下記のように定義する。

    //  example/template_cpp17/func_type_ut.cpp 8

    // デストラクタが呼び出された時に、外部から渡されたフラグをtrueにする
    struct A {
        explicit A(bool& destructor_called) noexcept : destructor_called{destructor_called} {}
        ~A() { destructor_called = true; };

        bool& destructor_called;
    };

次に示すのは、第2パラメータに何も指定しないパターンである。 テスト用クラスAの動作確認ができるはずである。

    //  example/template_cpp17/func_type_ut.cpp 25

    {  // 第2パラメータに何も指定しない
        auto is_called = false;
        {
            auto ua = std::unique_ptr<A>{new A{is_called}};
            ASSERT_FALSE(is_called);  // uaのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // uaのデストラクタは呼ばれた
    }

次に示すのは、

    //  example/template_cpp17/func_type_ut.cpp 18

    void delete_func(A* a) noexcept { delete a; }

のポインタをstd::unique_ptrの第2パラメータに与えた例である。

    //  example/template_cpp17/func_type_ut.cpp 36

    {  // 第2パラメータに関数ポインタを与える
        auto is_called = false;
        {
            auto ua = std::unique_ptr<A, void (*)(A*)>{new A{is_called}, &delete_func};
            ASSERT_FALSE(is_called);  // uaのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // uaのデストラクタは呼ばれた
    }

次に示すのは、std::unique_ptrの第2パラメータにラムダを与えた例である。

    //  example/template_cpp17/func_type_ut.cpp 47

    {  // 第2パラメータにラムダを与える
        auto is_called = false;
        {
            auto delete_lambda = [](A* a) noexcept { delete a; };

            // ラムダ式の型はインスタンス毎に異なるため、
            // ラムダ式の型を取得するためには下記のようにdecltypeを使う必要がある
            auto ua = std::unique_ptr<A, decltype(delete_lambda)>{new A{is_called}, delete_lambda};
            ASSERT_FALSE(is_called);  // uaのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // uaのデストラクタは呼ばれた
    }

次に示すのは、 std::unique_ptrの第2パラメータに関数型オブジェクトの型(std::function)を与えた例である。

    //  example/template_cpp17/func_type_ut.cpp 62

    {  // 第2パラメータにstd::function型オブジェクトを与える
        auto is_called = false;
        {
            auto delete_obj = std::function<void(A*)>{[](A* a) noexcept { delete a; }};
            auto ua         = std::unique_ptr<A, std::function<void(A*)>&>{new A{is_called}, delete_obj};
            ASSERT_FALSE(is_called);  // uaのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // uaのデストラクタは呼ばれた
    }

以上で見てきたようにstd::unique_ptrの第2パラメータには、 第1パラメータのポインタを引数に取る関数型であれば指定できる。

このようなテンプレートパラメータを持つクラステンプレートの実装例を示すため、 「RAII(scoped guard)でも示したScopedGuardの実装を下記する。

やや意外だが、このようなテンプレートパラメータに特別な記法はなく、以下のようにすれば良い。

    //  h/scoped_guard.h 7

    /// @brief RAIIのためのクラス。コンストラクタ引数の関数オブジェクトをデストラクタから呼び出す
    ///
    #if __cplusplus >= 202002L   // c++20

    template <std::invocable F>  // Fが呼び出し可能であることを制約
    #else  // c++17

    template <typename F>
    #endif
    class ScopedGuard {
    public:
        explicit ScopedGuard(F&& f) noexcept : f_{f}
        {
        }

        ~ScopedGuard() { f_(); }
        ScopedGuard(ScopedGuard const&)            = delete;  // copyは禁止
        ScopedGuard& operator=(ScopedGuard const&) = delete;  // copyは禁止

    private:
        F f_;
    };

上記コードの抜粋である下記は、テンプレートパラメータを関数型に制約するためのものである。

    //  h/scoped_guard.h 7

    /// @brief RAIIのためのクラス。コンストラクタ引数の関数オブジェクトをデストラクタから呼び出す
    ///
    #if __cplusplus >= 202002L   // c++20

    template <std::invocable F>  // Fが呼び出し可能であることを制約
    #else  // c++17

    template <typename F>
    #endif

これがなければ、誤った型の関数型をテンプレートパラメータに指定できてしまう。

以下にこのクラステンプレートの単体テストを示す。

まずは、以下の関数と静的変数の組み合わせ

    //  example/template_cpp17/func_type_ut.cpp 78

    bool is_caleded_in_static{false};
    void caleded_by_destructor() noexcept { is_caleded_in_static = true; }

を使った例である。

    //  example/template_cpp17/func_type_ut.cpp 86

    {  // Fに関数ポインタを与える
        is_caleded_in_static = false;
        {
            auto sg = ScopedGuard{&caleded_by_destructor};
            ASSERT_FALSE(is_caleded_in_static);  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_caleded_in_static);  // sgのデストラクタは呼ばれた
    }

次に示すのは、それぞれにラムダ式とstd::functionを使った2例である。

    //  example/template_cpp17/func_type_ut.cpp 101

    {  // Fにラムダ式を与える
        auto is_called = false;
        {
            auto gs = ScopedGuard{[&is_called]() noexcept { is_called = true; }};
            ASSERT_FALSE(is_called);  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }
    {  // Fにstd::function型オブジェクトを与える
        auto is_called = false;
        {
            auto f  = std::function<void(void)>{[&is_called]() noexcept { is_called = true; }};
            auto gs = ScopedGuard{std::move(f)};  // sgのデストラクタは呼ばれていない
            ASSERT_FALSE(is_called);              // sgのデストラクタは呼ばれた
        }
        ASSERT_TRUE(is_called);
    }

次に示すのは関数型オブジェクト

    //  example/template_cpp17/func_type_ut.cpp 123

    struct TestFunctor {
        explicit TestFunctor(bool& is_called) : is_called_{is_called} {}
        void  operator()() noexcept { is_called_ = true; }
        bool& is_called_;
    };

を使った例である。

    //  example/template_cpp17/func_type_ut.cpp 134

    {  // Fに関数型オブジェクトを与える
        auto is_called = false;
        auto tf        = TestFunctor{is_called};
        {
            auto sg = ScopedGuard{std::move(tf)};  // C++17以降の記法
            ASSERT_FALSE(is_called);               // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }

C++17からサポートされた「クラステンプレートのテンプレートパラメータ推論」が使えないC++14以前では、 下記に示すようにScopedGuardのテンプレートラメータ型を指定しなければならない煩雑さがある。

    //  example/template_cpp17/func_type_ut.cpp 146
    {  // Fに関数型オブジェクトを与える
        auto is_called = false;
        auto tf        = TestFunctor{is_called};
        {
            auto sg = ScopedGuard<TestFunctor>{std::move(tf)};  // C++14以前の記法
            ASSERT_FALSE(is_called);                            // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }

これを回避するためには下記のような関数テンプレートを用意すればよい。

    //  h/scoped_guard.h 38

    template <typename F>
    ScopedGuard<F> MakeScopedGuard(F&& f) noexcept
    {
        return ScopedGuard<F>(std::move(f));
    }

下記に示した単体テストから明らかな通り、関数テンプレートの型推測の機能により、 テンプレートパラメータを指定する必要がなくなる。

    //  example/template_cpp17/func_type_ut.cpp 161

    {  // Fに関数ポインタを与える
        is_caleded_in_static = false;
        {
            auto sg = MakeScopedGuard(&caleded_by_destructor);
            ASSERT_FALSE(is_caleded_in_static);  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_caleded_in_static);  // sgのデストラクタは呼ばれた
    }
    {  // Fにラムダ式を与える
        auto is_called = false;
        {
            auto sg = MakeScopedGuard([&is_called]() noexcept { is_called = true; });
            ASSERT_FALSE(is_called);  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }
    {  // Fにstd::function型オブジェクトを与える
        auto is_called = false;
        {
            auto f  = std::function<void(void)>{[&is_called]() noexcept { is_called = true; }};
            auto sg = MakeScopedGuard(std::move(f));
            ASSERT_FALSE(is_called);  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }
    {  // Fに関数型オブジェクトを与える
        auto is_called = false;
        auto tf        = TestFunctor{is_called};
        {
            auto sg = MakeScopedGuard(std::ref(tf));  // std::refが必要
            ASSERT_FALSE(is_called);                  // sgのデストラクタは呼ばれていない
        }
        ASSERT_TRUE(is_called);  // sgのデストラクタは呼ばれた
    }

このような便利なテンプレートは、Nstdのようなライブラリで定義、宣言し、 ソースコード全域からアクセスできるようにするとプロジェクトの開発効率が少しだけ高まる。

注意点まとめ

本章では、テンプレートメタプログラミングのテクニックや注意点について解説したが、 本章の情報量は多く、また他の章で行ったものもあるため以下にそれらをまとめる。

    //  example/template_cpp17/etc_ut.cpp 7

    template <typename T> constexpr int32_t f(T) noexcept { return 0; }                   // f-0
    template <typename T> constexpr int32_t f(T*) noexcept { return 1; }                  // f-1
    template <>           constexpr int32_t f<int32_t*>(int32_t*) noexcept { return 2; }  // f-2
    // f-2はf-1の特殊化のように見えるが、T == int32_t*の場合のf-0の特殊化である。
    //  example/template_cpp17/etc_ut.cpp 18

    // 以下、f-0/f-1/f-2のテスト
    auto c   = char{0};
    auto i32 = 0;

    // 以下はおそらく直感通り
    static_assert(f(0) == 0);               // f-0が呼ばれる
    static_assert(f(&c) == 1);              // f-1が呼ばれる
    static_assert(f<int32_t*>(&i32) == 2);  // f-2が呼ばれる

    // 以下はおそらく直感に反する
    static_assert(f(nullptr) == 0);  // f-1ではなく、f-0が呼ばれる
    static_assert(f(&i32) == 1);     // f-2ではなく、f-1が呼ばれる

ダイナミックメモリアロケーション

本章で扱うダイナミックメモリアロケーションとは、new/delete、malloc/free によるメモリ確保/解放のことである。

malloc/freeは、

等の問題(「malloc/freeの問題点」参照)を持っている。 new/deleteは通常malloc/freeを使って実装されているため同じ問題を持っているが、 これらが汎用OS上でのアプリケーションで実際の不具合につながることはほとんどない。一方で、

ような組み込みソフトでは、上記の2点は致命的な不具合につながる。

本章では、この問題を回避するための技法を紹介する。


この章の構成

   malloc/freeの問題点
   グローバルnew/deleteのオーバーロード
    固定長メモリプール
    グローバルnew/deleteのオーバーロードの実装
    プレースメントnew
    デバッグ用イテレータ

   クラスnew/deleteのオーバーロード
   STLコンテナのアロケーター
    STLコンテナ用アロケータ
    可変長メモリプール
    デバッグ用イテレータ
    エクセプション処理機構の変更

   Polymorphic Memory Resource(pmr)
    std::pmr::memory_resource
    std::pmr::polymorphic_allocator
    pool_resource

このドキュメントの構成に戻る。


malloc/freeの問題点

UNIX系のOSでの典型的なmalloc/freeの実装例の一部を以下に示す (この実装は長いため、 全体は巻末の「example/dynamic_memory_allocation/malloc_ut.cpp」に掲載する)。

    //  example/dynamic_memory_allocation/malloc_ut.cpp 19

    namespace {

    struct header_t {
        header_t* next;
        size_t    n_nuits;  // header_tが何個あるか
    };

    header_t*        header{nullptr};
    SpinLock         spin_lock{};
    constexpr size_t unit_size{sizeof(header_t)};

    inline bool sprit(header_t* header, size_t n_nuits, header_t*& next) noexcept
    {
        // ...
    }

    inline void concat(header_t* front, header_t* rear) noexcept
    {
        // ...
    }

    header_t* set_back(void* mem) noexcept { return static_cast<header_t*>(mem) - 1; }

    static_assert(sizeof(header_t) == alignof(std::max_align_t));

    void* malloc_inner(size_t size) noexcept
    {
        // ...
    }
    }  // namespace
    //  example/dynamic_memory_allocation/malloc_ut.cpp 105

    void free(void* mem) noexcept
    {
        header_t* mem_to_free = set_back(mem);

        mem_to_free->next = nullptr;

        auto lock = std::lock_guard{spin_lock};

        if (header == nullptr) {
            header = mem_to_free;
            return;
        }

        if (mem_to_free < header) {
            concat(mem_to_free, header);
            header = mem_to_free;
            return;
        }

        auto curr = header;
        for (; curr->next != nullptr; curr = curr->next) {
            if (mem_to_free < curr->next) {  // 常に curr < mem_to_free
                concat(mem_to_free, curr->next);
                concat(curr, mem_to_free);
                return;
            }
        }

        concat(curr, mem_to_free);
    }

    void* malloc(size_t size) noexcept
    {
        void* mem = malloc_inner(size);

        if (mem == nullptr) {
            auto const add_size = Roundup(unit_size, 1024 * 1024 + size);  // 1MB追加

            header_t* add = static_cast<header_t*>(sbrk(add_size));
            add->n_nuits  = add_size / unit_size;
            free(++add);
            mem = malloc_inner(size);
        }

        return mem;
    }

上記で示したようにmalloc/freeで使用されるメモリはHeader_t型のheaderで管理され、 このアクセスの競合はspin_lockによって回避される。 headerが管理するメモリ用域からのメモリの切り出しはmalloc_innerによって行われるが、 下のフラグメントの説明でも示す通り、 headerで管理されたメモリは長さの上限が単純には決まらないリスト構造になるため、 このリストをなぞるmalloc/freeにリアルタイム性の保証をすることは困難である。

アプリケーションが実行する最初のmallocから呼び出されるmalloc_innerは、 headerがnullptrであるため必ずnullptrを返すことになる。

上記の抜粋である下記のコードによりmalloc_innerの戻りがnullptrであった場合、sbrkが呼び出される。

    //  example/dynamic_memory_allocation/malloc_ut.cpp 148

    if (mem == nullptr) {
        auto const add_size = Roundup(unit_size, 1024 * 1024 + size);  // 1MB追加

        header_t* add = static_cast<header_t*>(sbrk(add_size));
        add->n_nuits  = add_size / unit_size;
        free(++add);
        mem = malloc_inner(size);
    }

sbrkとはOSからメモリを新たに取得するための下記のようなシステムコールである。

    //  example/dynamic_memory_allocation/malloc_ut.cpp 13

    extern "C" void* sbrk(ptrdiff_t __incr);

OSがアプリケーションに割り当てるための十分なメモリを持っていない場合、 sbrkは ページング によるメモリ確保のトリガーとなる。 これはOSのファイルシステムの動作を含む処理であるため、やはりリアルタイム性の保証は困難である。

フリースタンディング環境では、sbrkのようなシステムコールは存在しないため、 アプリケーションの未使用領域や静的に確保した領域を上記コードで示したようなリスト構造で管理し、 mallocで使用することになる。 このような環境では、sbrkによるリアルタイム性の阻害は発生しないものの、 メモリ管理ためのリスト構造があるため、やはりリアルタイム性の保証は難しい。

次にもう一つの問題である「メモリのフラグメントを起こす」ことについて見て行く。

    //  example/dynamic_memory_allocation/malloc_ut.cpp 190

    void* mem[1024];

    for (auto& m : mem) {  // 32バイト x 1024個のメモリ確保
        m = malloc(32);
    }

    // memを使用した何らかの処理
    // ...

    for (auto i = 0U; i < ArrayLength(mem); i += 2) {  // 512個のメモリを解放
        free(mem[i]);
    }

上記のような処理の後、解放されたメモリは、32バイト (メモリヘッダがあるため、実際はもう少し大きい)の断片が512個ある状態になるため、 このサイズを超える新たなmallocの呼び出しには使えない。 このため、ページングが行えないようなOS上のアプリケーションでは、 メモリは十分にあるにもかかわらずmallocが失敗してしまうことが起こり得る。

また、上記freeの実装例の抜粋である下記のコードからわかるように、 このように断片化されたメモリは、そのアドレス順にソートされた単方向リストによって管理される。

    //  example/dynamic_memory_allocation/malloc_ut.cpp 120

    if (mem_to_free < header) {
        concat(mem_to_free, header);
        header = mem_to_free;
        return;
    }

    auto curr = header;
    for (; curr->next != nullptr; curr = curr->next) {
        if (mem_to_free < curr->next) {  // 常に curr < mem_to_free
            concat(mem_to_free, curr->next);
            concat(curr, mem_to_free);
            return;
        }
    }

    concat(curr, mem_to_free);

この状態でさらにメモリ解放が行われた場合、 freeはこのリストを辿りメモリを最適な場所に戻す必要がある。 戻したメモリがリスト前後のメモリと隣接していれば、それらは結合される。 この処理は断片化への対策であるが、 ページングの無いOS上のアプリケーションにとっては不十分であるばかりでなく、

といったリアルタイム処理を阻害する別の問題も発生させる (繰り返しになるが、windows/linuxのような通常のOS上のアプリケーションでは、 このような仕様が問題になることはほとんどない)。

グローバルnew/deleteのオーバーロード

すでに述べたように、組み込みソフトにはmalloc/freeを使用したnew/deleteは使えない可能性が高い。 そのような場合に備えC++11ではグローバルなnew/deleteのオーバーロードをサポートする。 ここでは、そのようなnew/deleteの実装例を示すが、 その前にnew/deleteの内部実装用メモリ管理用ライブラリを実装する。

固定長メモリプール

malloc/freeにリアルタイム性がない原因は、

ためである。従って、この問題に対処するためのメモリ管理システムは、

する必要がある。これを含めこの章で開発するメモリ管理システムをメモリプールと呼ぶことにする。

グローバルnew/deleteのオーバーロードの実装」で示すように、 このメモリプールは管理する固定長のメモリブロックのサイズごとに複数必要になる一方で、 これらを統合的に扱う必要も出てくる。

そのため、固定長のメモリプールは、

によって実装することにする。

まずは、MPoolを下記に示す (「ファイル位置を静的に保持したエクセプションクラスの開発」参照)。

    //  example/dynamic_memory_allocation/mpool.h 12

    class MPool {
    public:
        explicit MPool(size_t max_size) : max_size_{max_size} {}

        void* Alloc(size_t size)
        {
            if (size > max_size_) {
                throw MAKE_EXCEPTION(MPoolBadAlloc, "MPF : memory size too big");
            }

            void* mem = alloc(size);

            if (mem == nullptr) {
                throw MAKE_EXCEPTION(MPoolBadAlloc, "MPF : out of memory");
            }

            return mem;
        }

        void* AllocNoExcept(size_t size) noexcept { return alloc(size); }

        void   Free(void* area) noexcept { free(area); }
        size_t GetSize() const noexcept { return get_size(); }           // メモリ最小単位
        size_t GetCount() const noexcept { return get_count(); }         // メモリ最小単位が何個取れるか
        size_t GetCountMin() const noexcept { return get_count_min(); }  // GetCount()の最小値
        bool   IsValid(void const* area) const noexcept { return is_valid(area); }

    protected:
        ~MPool() = default;

    private:
        size_t const max_size_;

        virtual void*  alloc(size_t size) noexcept               = 0;
        virtual void   free(void* area) noexcept                 = 0;
        virtual size_t get_size() const noexcept                 = 0;
        virtual size_t get_count() const noexcept                = 0;
        virtual size_t get_count_min() const noexcept            = 0;
        virtual bool   is_valid(void const* area) const noexcept = 0;
    };

次に、MPoolFixedを下記に示す。

    //  example/dynamic_memory_allocation/mpool_fixed.h 25

    template <uint32_t MEM_SIZE, uint32_t MEM_COUNT>
    class MPoolFixed final : public MPool {
    public:
        MPoolFixed() noexcept : MPool{mem_chunk_size_} {}

    private:
        using chunk_t = Inner_::mem_chunk<MEM_SIZE>;
        static constexpr size_t mem_chunk_size_{sizeof(chunk_t)};

        size_t           mem_count_{MEM_COUNT};
        size_t           mem_count_min_{MEM_COUNT};
        chunk_t          mem_chunk_[MEM_COUNT]{};
        chunk_t*         mem_head_{setup_mem()};
        mutable SpinLock spin_lock_{};

        chunk_t* setup_mem() noexcept
        {
            for (auto i = 0U; i < MEM_COUNT - 1; ++i) {
                mem_chunk_[i].next = &mem_chunk_[i + 1];
            }

            mem_chunk_[MEM_COUNT - 1].next = nullptr;

            return mem_chunk_;
        }

        virtual void* alloc(size_t size) noexcept override
        {
            assert(size <= mem_chunk_size_);

            auto lock = std::lock_guard{spin_lock_};

            auto mem = mem_head_;

            if (mem != nullptr) {
                mem_head_      = mem_head_->next;
                mem_count_min_ = std::min(--mem_count_, mem_count_min_);
            }

            return mem;
        }

        virtual void free(void* mem) noexcept override
        {
            assert(is_valid(mem));

            auto lock = std::lock_guard{spin_lock_};

            chunk_t* curr_head = static_cast<chunk_t*>(mem);
            curr_head->next    = mem_head_;
            mem_head_          = curr_head;

            mem_count_min_ = std::min(++mem_count_, mem_count_min_);
        }

        virtual size_t get_size() const noexcept override { return mem_chunk_size_; }
        virtual size_t get_count() const noexcept override { return mem_count_; }
        virtual size_t get_count_min() const noexcept override { return mem_count_min_; }

        virtual bool is_valid(void const* mem) const noexcept override
        {
            return (&mem_chunk_[0] <= mem) && (mem <= &mem_chunk_[MEM_COUNT - 1]);
        }
    };

上記コードからわかる通り、MPoolFixedは初期化直後、 サイズMEM_SIZのメモリブロックをMEM_COUNT個、保持する。 個々のメモリブロックは、下記のコードのalignas/alignofでアライメントされた領域となる。

    //  example/dynamic_memory_allocation/mpool_fixed.h 11

    constexpr size_t MPoolFixed_MinSize{32};

    namespace Inner_ {
    template <uint32_t MEM_SIZE>
    union mem_chunk {
        mem_chunk* next;

        // MPoolFixed_MinSizeの整数倍のエリアを、最大アラインメントが必要な基本型にアライン
        alignas(alignof(std::max_align_t)) uint8_t mem[Roundup(MPoolFixed_MinSize, MEM_SIZE)];
    };
    }  // namespace Inner_

MPoolFixedに限らずメモリアロケータが返すメモリは、 どのようなアライメントにも対応できなければならないため、このようにする必要がある。

MPoolFixed::alloc/MPoolFixed::freeを見ればわかる通り、malloc/freeの実装に比べ格段にシンプルであり、 これによりリアルタイム性の保障は容易である。

なお、この実装ではmalloc/freeと同様に下記のSpinLockを使用したが、 このロックは、ラウンドロビンでスケジューリングされるスレッドの競合を防ぐためのものであり、 固定プライオリティでのスケジューリングが前提となるような組み込みソフトで使用した場合、 デッドロックを引き起こす可能性がある。 組み込みソフトでは、割り込みディセーブル/イネーブルを使ってロックすることを推奨する。

    //  example/dynamic_memory_allocation/spin_lock.h 3

    #include <atomic>

    class SpinLock {
    public:
        void lock() noexcept
        {
            while (state_.exchange(state::locked, std::memory_order_acquire) == state::locked) {
                ;  // busy wait
            }
        }

        void unlock() noexcept { state_.store(state::unlocked, std::memory_order_release); }

    private:
        enum class state { locked, unlocked };
        std::atomic<state> state_{state::unlocked};
    };

MPoolFixedの単体テストは、下記のようになる。

    //  example/dynamic_memory_allocation/mpool_fixed_ut.cpp 10

    Inner_::mem_chunk<5> mc5[3];
    static_assert(32 == sizeof(mc5[0]));
    static_assert(96 == sizeof(mc5));

    auto mc33 = Inner_::mem_chunk<33>{};
    static_assert(64 == sizeof(mc33));
    //  example/dynamic_memory_allocation/mpool_fixed_ut.cpp 106

    auto mpf = MPoolFixed<33, 2>{};

    ASSERT_EQ(64, mpf.GetSize());
    ASSERT_EQ(2, mpf.GetCount());
    ASSERT_EQ(2, mpf.GetCountMin());
    ASSERT_FALSE(mpf.IsValid(&mpf));  // mpfの管理外のアドレス

    auto m0 = mpf.Alloc(1);
    ASSERT_TRUE(mpf.IsValid(m0));  // mpfの管理のアドレス
    ASSERT_NE(nullptr, m0);
    ASSERT_EQ(1, mpf.GetCount());
    ASSERT_EQ(1, mpf.GetCountMin());

    auto m1 = mpf.Alloc(1);
    ASSERT_TRUE(mpf.IsValid(m1));  // mpfの管理のアドレス
    ASSERT_NE(nullptr, m1);
    ASSERT_EQ(0, mpf.GetCount());
    ASSERT_EQ(0, mpf.GetCountMin());

    // mpfが空の場合のテスト
    ASSERT_THROW(mpf.Alloc(1), MPoolBadAlloc);  // MPoolBadAlloc例外が発生するはず
    auto m2 = mpf.AllocNoExcept(1);
    ASSERT_EQ(nullptr, m2);
    ASSERT_EQ(0, mpf.GetCount());

    mpf.Free(m0);
    ASSERT_EQ(1, mpf.GetCount());
    ASSERT_EQ(0, mpf.GetCountMin());

    mpf.Free(m1);
    ASSERT_EQ(2, mpf.GetCount());
    ASSERT_EQ(0, mpf.GetCountMin());

    ASSERT_THROW(mpf.Alloc(65), MPoolBadAlloc);  // MPoolBadAlloc例外が発生するはず

上記テストで使用したMPoolBadAllocは下記のように定義されたクラスであり (「ファイル位置を静的に保持したエクセプションクラスの開発」参照)、

    //  example/h/nstd_exception.h 11

    /// @class Exception
    /// @brief StaticString<>を使ったエクセプションクラス
    ///        下記のMAKE_EXCEPTIONを使い生成
    /// @tparam E   std::exceptionから派生したエクセプションクラス
    /// @tparam N   StaticString<N>
    template <typename E, size_t N>
    #if __cplusplus >= 202002L  // c++20
    requires std::derived_from<E, std::exception>
    #endif
    class Exception : public E {
    public:
        static_assert(std::is_base_of_v<std::exception, E>);

        Exception(StaticString<N> const& what_str) noexcept : what_str_{what_str} {}
        char const* what() const noexcept override { return what_str_.String(); }

    private:
        StaticString<N> const what_str_;
    };

    #define MAKE_EXCEPTION(E__, msg__) Nstd::MakeException<E__, __LINE__>(__FILE__, msg__)
    //  example/dynamic_memory_allocation/mpool.h 7

    class MPoolBadAlloc : public std::bad_alloc {  // Nstd::Exceptionの基底クラス
    };

MPoolから派生したクラスが、

のような処理の継続ができない場合に用いるエクセプション用クラスである。

グローバルnew/deleteのオーバーロードの実装

固定長メモリプールを使用したoperator newのオーバーロードの実装例を以下に示す。

    //  example/dynamic_memory_allocation/global_new_delete.cpp 31

    namespace {
    MPool* mpool_table[32];

    // mainの前に呼ばれるため、mpool_tableを初期化するには下記のような方法が必要
    bool is_setup{false};

    void setup() noexcept
    {
        is_setup = true;

        mpool_table[0] = gen_mpool<1, 128>();  //   32
        mpool_table[1] = gen_mpool<2, 128>();  //   64
        mpool_table[2] = gen_mpool<3, 128>();  //   96

        // ...

        mpool_table[29] = gen_mpool<30, 128>();  //  960
        mpool_table[30] = gen_mpool<31, 128>();  //  992
        mpool_table[31] = gen_mpool<32, 128>();  // 1024
    }

    size_t size2index(size_t v) noexcept { return (((v + (min_unit - 1)) & ~(min_unit - 1)) / min_unit) - 1; }
    }  // namespace

    [[nodiscard]] void* operator new(std::size_t size)
    {
        if (!is_setup) {
            setup();
        }

        for (auto i = size2index(size); i < ArrayLength(mpool_table); ++i) {
            void* mem = mpool_table[i]->AllocNoExcept(size);
            if (mem != nullptr) {
                return mem;
            }
        }

        throw std::bad_alloc{};

        static char fake[0];

        return fake;
    }

上記で定義されたoperator newは、

のような仕様を持つため、実際に使う場合は、メモリのサイズや個数の調整が必要だろうが、 後で詳しく見るようにリアルタイム性の阻害となるようなコードはないため、 リアルタイム性が必要なソフトウェアでも使用可能である。

静的オブジェクトを含まないアプリケーションでは、 上記のコードのsetupで行っているmpool_tableの初期化は 一様初期化で行った方が良いが、 例で用いたアプリケーションにはnewを行う静的オブジェクトが存在するため (google testは静的オブジェクトを利用する)、 setupで行っているような方法以外では、 最初のoperator newの呼び出しより前にmpool_tableの初期化をすることはできない。

mpool_tableはMPoolポインタを保持するが、そのポインタが指すオブジェクトの実態は、 gen_mpool<>が生成したMPoolFixed<>オブジェクトである。 gen_mpool<>については、「プレースメントnew」で説明する。

size2indexは、要求されたサイズから、 それに対応するMPoolポインタを保持するmpool_tableのインデックスを導出する関数である。

この実装では対応するMPoolが空であった場合、 それよりも大きいメモリブロックを持つMPoolからメモリを返す仕様としたが、 その時点でアサーションフェールさせ (つまり、対応するMPoolが空である状態でのAllocの呼び出しをバグとして扱う)、 MEM_COUNTの値を見直した方が、 より少ないメモリで動作する組み込みソフトを作りやすいだろう。

operator deleteについては、下記の2種類が必要となる。

    //  example/dynamic_memory_allocation/global_new_delete.cpp 106

    void operator delete(void* mem) noexcept
    {
        for (MPool* mp : mpool_table) {
            if (mp->IsValid(mem)) {
                mp->Free(mem);
                return;
            }
        }
        assert(false);
    }

    void operator delete(void* mem, std::size_t size) noexcept
    {
        for (auto i = size2index(size); i < ArrayLength(mpool_table); ++i) {
            if (mpool_table[i]->IsValid(mem)) {
                mpool_table[i]->Free(mem);
                return;
            }
        }
        assert(false);
    }

operator delete(void* mem, std::size_t size)は、完全型のオブジェクトのメモリ解放に使用され、 operator delete(void* mem)は、それ以外のメモリ解放に使用される。

コードから明らかな通り、size付きのoperator deleteの方がループの回転数が少なくなるため、 高速に動作するが、malloc/freeの実装(「malloc/freeの問題点」参照)で使用したHeader_t を導入することでこの実行コストはほとんど排除できる。 そのトレードオフとしてメモリコストが増えるため、ここでは例示した仕様にした。

プレースメントnew

グローバルnew/deleteのオーバーロードの実装」で使用したgen_mpool<>は、 下記のように定義されている。

    //  example/dynamic_memory_allocation/global_new_delete.cpp 8

    namespace {

    constexpr size_t min_unit{MPoolFixed_MinSize};

    template <uint32_t N_UNITS, uint32_t MEM_COUNT>
    [[nodiscard]] MPool* gen_mpool() noexcept
    {
        using mp_t = MPoolFixed<min_unit * N_UNITS, MEM_COUNT>;

        static union {
            std::max_align_t max_align;
            uint8_t          mem[sizeof(mp_t)];
        } mem;

        static_assert(static_cast<void*>(&mem.max_align) == static_cast<void*>(mem.mem));
        static_assert(sizeof(mem) >= sizeof(mp_t));

        return new (mem.mem) mp_t;  // プレースメントnew
    }
    }  // namespace

この関数テンプレートは、MPoolFixed<>オブジェクトを生成し、それをMPool型のポインタとして返す。 MPoolFixedの生成は、上記で示したようにプレースメントnewを使用して行っている。

gen_mpool<>内でMPoolFixedのstaticなインスタンスを定義した方がシンプルに実装できるが、 その場合、main()終了後、そのインスタンスは解放され(デストラクタが呼び出され)、その後、 他の静的オブジェクトの解放が行われると、その延長でoperator deleteが呼び出され、 ライフタイム終了後のMPoolFixedのstaticなインスタンスが使われてしまう。

現在のMPoolFixedの実装ではこの操作で不具合は発生しないが、 解放済のオブジェクトを操作することは避けるべきであるため、 MPoolFixedの生成にプレースメントnewを用いている。

プレースメントnewで生成したオブジェクトをdeleteすることはできず、 デストラクタはユーザが明示的に呼び出さない限り、呼び出されない。 ここでは、プレースメントnewのこの特性を利用したが、 逆に、この特性があるため、 ここでの実装のような特殊な事情がある場合を除き、プレースメントnewを使うべきではない (デストラクタの明示的な呼び出しを忘れるとリソースリークしてしまう)。

デバッグ用イテレータ

この章で例示したグローバルnew/deleteは、すでに述べたように適切なメモリの量を調整する必要がある。 そのためには、これを使用するアプリケーションをある程度動作させた後、 グローバルnew/deleteのメモリの消費量を計測しなければならない。

下記のコードは、そのためのインターフェースを提供する。

    //  example/dynamic_memory_allocation/global_new_delete.h 4

    class GlobalNewDeleteMonitor {
    public:
        MPool const* const* cbegin() const noexcept;
        MPool const* const* cend() const noexcept;
        MPool const* const* begin() const noexcept;
        MPool const* const* end() const noexcept;
    };
    //  example/dynamic_memory_allocation/global_new_delete.cpp 132

    MPool const* const* GlobalNewDeleteMonitor::begin() const noexcept { return &mpool_table[0]; }
    MPool const* const* GlobalNewDeleteMonitor::end() const noexcept { return &mpool_table[ArrayLength(mpool_table)]; }

    MPool const* const* GlobalNewDeleteMonitor::cbegin() const noexcept { return begin(); }
    MPool const* const* GlobalNewDeleteMonitor::cend() const noexcept { return end(); }

このインターフェースを下記のように使用することで、

    //  example/dynamic_memory_allocation/global_new_delete_ut.cpp 119

    auto gm = GlobalNewDeleteMonitor{};

    std::cout << "  size current   min" << std::endl;
    std::cout << "  ------------------" << std::endl;

    for (MPool const* mp : gm) {
        std::cout << std::setw(6) << mp->GetSize() << std::setw(8) << mp->GetCount() << std::setw(6)
                  << mp->GetCountMin() << std::endl;
    }

下記のようにメモリの現在の状態や使用履歴を見ることができる。

          size current   min
          ------------------
            32      90     0
            64      78    74
            96     127   125

           ...

           992     128   128
          1024     128     0

実際の組み込みソフトの開発では、 デバッグ用入出力機能からこのようなコードを実行できるようにすることで、 グローバルnew/deleteが使用するそれぞれのMPoolFixedインスタンスのメモリの調整ができるだろう。

クラスnew/deleteのオーバーロード

グローバルnew/deleteのオーバーロードの実装」で示したコードのロックを、 「割り込みディセーブル/イネーブル」に置き換えることで、リアルタイム性を保障することができるが、 この機構はある程度多くのメモリを必要とするため、 極めてメモリ制限の厳しいシステムでは使用が困難である場合もあるだろう。

そのような場合、非スタック上でのオブジェクト生成には、

とし、グローバルnewを使用しないことが、より良いメモリ使用方法となり得る。

グローバルnewを使わずに動的にオブジェクトを生成するためには、

という2つの選択肢が考えられるが、すでに述べた理由によりプレースメントnewの使用は避けるべきである。 従って、その方法はクラス毎のnew/deleteのオーバーロードになる。

メモリ管理に「固定長メモリプール」で示したMPoolFixedを利用した実装例を以下に示す。

    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 14

    struct A {
        A() noexcept : name0{"A"} {}
        char const* name0;

        [[nodiscard]] static void* operator new(size_t size);
        static void                operator delete(void* mem) noexcept;
        static void                operator delete(void* mem, std::size_t size) noexcept;

        [[nodiscard]] static void* operator new[](size_t size)                             = delete;
        static void                operator delete[](void* mem) noexcept                   = delete;
        static void                operator delete[](void* mem, std::size_t size) noexcept = delete;
    };

    MPoolFixed<sizeof(A), 3> mpf_A;

    void* A::operator new(size_t size) { return mpf_A.Alloc(size); }
    void A::operator delete(void* mem) noexcept { mpf_A.Free(mem); }
    void A::operator delete(void* mem, std::size_t) noexcept { mpf_A.Free(mem); }

以下の単体テストが示す通り、 静的に定義したMPoolFixedインスタンスがオーバーロードしたnew/deleteから使われていることがわかる (従ってグローバルnew/deleteは使われていないこともわかる)。

    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 43

    ASSERT_EQ(3, mpf_A.GetCount());

    {
        auto a = std::make_unique<A>();
        ASSERT_STREQ("A", a->name0);
        ASSERT_EQ(2, mpf_A.GetCount());
    }
    ASSERT_EQ(3, mpf_A.GetCount());

    {
        auto a = std::make_unique<A>();
        ASSERT_STREQ("A", a->name0);
        ASSERT_EQ(2, mpf_A.GetCount());

        auto b = std::make_unique<A>();
        ASSERT_STREQ("A", b->name0);
        ASSERT_EQ(1, mpf_A.GetCount());

        auto c = std::make_unique<A>();
        ASSERT_STREQ("A", c->name0);
        ASSERT_EQ(0, mpf_A.GetCount());

        ASSERT_THROW(std::make_unique<A>(), MPoolBadAlloc);
    }
    ASSERT_EQ(3, mpf_A.GetCount());

しかし、この方法ではnewのオーバーロードを行うクラス毎に、

    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 20

    [[nodiscard]] static void* operator new(size_t size);
    static void                operator delete(void* mem) noexcept;
    static void                operator delete(void* mem, std::size_t size) noexcept;

    [[nodiscard]] static void* operator new[](size_t size)                             = delete;
    static void                operator delete[](void* mem) noexcept                   = delete;
    static void                operator delete[](void* mem, std::size_t size) noexcept = delete;

を記述しなければならず、コードクローンの温床となってしまう。 これを避けるためには、 CRTP(curiously recurring template pattern) を利用した下記のようなクラステンプレートを導入すれば良い。

    //  example/dynamic_memory_allocation/op_new.h 5

    template <typename T>
    class OpNew {
    public:
        [[nodiscard]] static void* operator new(size_t size) { return mpool_.Alloc(size); }
        static void                operator delete(void* mem) noexcept { mpool_.Free(mem); }
        static void                operator delete(void* mem, std::size_t) noexcept { mpool_.Free(mem); }

        [[nodiscard]] static void* operator new[](size_t size)                             = delete;
        static void                operator delete[](void* mem) noexcept                   = delete;
        static void                operator delete[](void* mem, std::size_t size) noexcept = delete;

    private:
        static MPool& mpool_;
    };

このOpeNewを使用した「new/deleteのオーバーロードを持つ基底クラスとその一連の派生クラス」 の実装例を以下に示す。

    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 77

    struct A : public OpNew<A> {
        A() noexcept : name0{"A"} {}
        char const* name0;
    };

    struct B : A {
        B() noexcept : name1{"B"} {}
        char const* name1;
    };

    struct C : A {
        C() noexcept : name1{"C"} {}
        char const* name1;
    };

    struct D : C {
        D() noexcept : name2{"D"} {}
        char const* name2;
    };

    MPoolFixed<MaxSizeof<A, B, C, D>(), 10> mpf_ABCD;

    template <>
    MPool& OpNew<A>::mpool_ = mpf_ABCD;

OpNewをクラステンプレートとし、内部で利用しないテンプレートパラメータを宣言した理由は、 別のクラスからはOpNewの別インスタンスを使用できるようにするためである。

この方法は、コードが若干複雑にることを除けば、 「グローバルnew/deleteのオーバーロード」に比べ、優れているように見えてしまうかもしれないが、 下記のように、さらに派生クラスを定義してしまうとnewが失敗してしまうことがあるので注意が必要である。

    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 135

    struct Large : A {
        uint8_t buff[1024];  // mpf_ABCDのメモリブロックのサイズを超える
    };

    TEST(NewDelete_Opt, class_new_delete_fixed_derived_large)
    {
        ASSERT_EQ(10, mpf_ABCD.GetCount());
        ASSERT_THROW(auto large = std::make_unique<Large>(), MPoolBadAlloc);  // サイズが大きすぎる
    }

なお、 下記のようなクラスをnew/deleteをオーバーロードしないすべのクラスの基底クラスとすることで、 偶発的にグローバルnewを使ってしまわないようにすることもできる。

    //  example/dynamic_memory_allocation/op_new_deleted.h 3

    class OpNewDeleted {
        static void* operator new(size_t size)                             = delete;
        static void  operator delete(void* mem) noexcept                   = delete;
        static void  operator delete(void* mem, std::size_t size) noexcept = delete;
    };
    //  example/dynamic_memory_allocation/class_new_delete_ut.cpp 150

    class DeletedNew : OpNewDeleted {  // プライベート継承
    };

    class DelivedDeletedNew : DeletedNew {  // プライベート継承
    };

    // DeletedNew* ptr0 { new DeletedNew };                // OpNewDeletedの効果でコンパイルエラー
    // DelivedDeletedNew* ptr1 { new DelivedDeletedNew };  // 同上

この記述方法は、コードインスペクションの省力化にも繋がるため、 OpNewを使うプロジェクトには導入するべきだろう。

STLコンテナのアロケーター

ここまで前提として来たような組み込みソフトにおいても、 その大部分のコードにリアルタイム性は不要であり、このような部分のコードにSTLコンテナが使用できれば、

等のポジティブな影響を期待できることは多い。 STLコンテナはこういった状況に備えて、ユーザ定義のアロケータを使用できるように定義されている。 ここでは、アロケータの定義例や、その使い方を示す。

STLコンテナ用アロケータ

アロケータの定義例を以下に示す。

    //  example/dynamic_memory_allocation/mpool_allocator.h 7

    template <typename T>
    class MPoolBasedAllocator {
    public:
        using pointer                                = T*;
        using const_pointer                          = T const*;
        using value_type                             = T;
        using propagate_on_container_move_assignment = std::true_type;
        using is_always_equal                        = std::true_type;
        using size_type                              = size_t;
        using difference_type                        = size_t;

        template <class U>
        struct rebind {
            using other = MPoolBasedAllocator<U>;
        };

        T*   allocate(size_type count) { return static_cast<pointer>(mpool_.Alloc(count * sizeof(T))); }
        void deallocate(T* mem, size_type) noexcept { mpool_.Free(mem); }

    private:
        static MPool& mpool_;
    };

    template <class T>  // T型のMPoolBasedAllocatorはシステムに唯一
    bool operator==(MPoolBasedAllocator<T> const&, MPoolBasedAllocator<T> const&) noexcept
    {
        return true;
    }

    template <class T, class U>
    bool operator==(MPoolBasedAllocator<T> const&, MPoolBasedAllocator<U> const&) noexcept
    {
        return false;
    }

    template <class T, class U>
    bool operator!=(MPoolBasedAllocator<T> const& lhs, MPoolBasedAllocator<U> const& rhs) noexcept
    {
        return !(lhs == rhs);
    }

アロケータのパブリックなメンバやoperator ==、operator !=は、STLに従い定義している (STL allocator参照)。

上記コードからわかるようにメモリの実際のアロケーションには、 これまでと同様にMPoolから派生したクラスを使用するが、 リアルタイム性は不要であるためメモリ効率が悪いMPoolFixedは使わない。 代わりに、可変長メモリを扱うためメモリ効率がよいMPoolVariabl (「可変長メモリプール」参照)を使う。

可変長メモリプール

可変長メモリプールを生成するMPoolVariableの実装は下記のようになる (全体は巻末の「example/dynamic_memory_allocation/mpool_variable.h」に掲載する)。

    //  example/dynamic_memory_allocation/mpool_variable.h 59

    template <uint32_t MEM_SIZE>
    class MPoolVariable final : public MPool {
    public:
        MPoolVariable() noexcept : MPool{MEM_SIZE}
        {
            header_->next    = nullptr;
            header_->n_nuits = sizeof(buff_) / Inner_::unit_size;
        }

        // 中略
        ...

    private:
        using header_t = Inner_::header_t;

        Inner_::buffer_t<MEM_SIZE> buff_{};
        header_t*                  header_{reinterpret_cast<header_t*>(buff_.buffer)};
        mutable SpinLock           spin_lock_{};
        size_t                     unit_count_{sizeof(buff_) / Inner_::unit_size};
        size_t                     unit_count_min_{sizeof(buff_) / Inner_::unit_size};

        virtual void* alloc(size_t size) noexcept override
        {
            // ...
        }

        virtual void free(void* mem) noexcept override
        {
            // ...
        }

        virtual size_t get_size() const noexcept override { return 1; }
        virtual size_t get_count() const noexcept override { return unit_count_ * Inner_::unit_size; }
        virtual size_t get_count_min() const noexcept override { return unit_count_min_ * Inner_::unit_size; }

        virtual bool is_valid(void const* mem) const noexcept override
        {
            return (&buff_ < mem) && (mem < &buff_.buffer[ArrayLength(buff_.buffer)]);
        }
    };

下記のようにMPoolVariable、 MPoolBasedAllocatorを使うことでnew char[]に対応するアロケータが定義できる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 11

    namespace {
    MPoolVariable<1024 * 64> mpv_allocator;
    }

    template <>
    MPool& MPoolBasedAllocator<char>::mpool_ = mpv_allocator;

下記の単体テストは、このアロケータを使うstd::stringオブジェクトの宣言方法と、 その振る舞いを示している。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 24

    auto rest = mpv_allocator.GetCount();
    auto str  = std::basic_string<char, std::char_traits<char>, MPoolBasedAllocator<char>>{"hehe"};

    ASSERT_TRUE(mpv_allocator.IsValid(str.c_str()));  // mpv_allocatorを使用してメモリ確保
    ASSERT_GT(rest, mpv_allocator.GetCount());        // mpv_allocatorのメモリが減っていることの確認

この長い宣言は、下記のようにすることで簡潔に記述できるようになる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 34

    using mpv_string = std::basic_string<char, std::char_traits<char>, MPoolBasedAllocator<char>>;

下記のように宣言、定義することで、

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 50

    template <>
    MPool& MPoolBasedAllocator<int>::mpool_ = mpv_allocator;

    using mpv_vector_int = std::vector<int, MPoolBasedAllocator<int>>;

下記の単体テストが示す通り、std::vector<int>にこのアロケータを使わせることもできる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 61

    auto rest = mpv_allocator.GetCount();
    auto ints = mpv_vector_int{1, 2, 3};

    ASSERT_TRUE(mpv_allocator.IsValid(&ints[0]));  // mpv_allocatorのメモリであることの確認
    ASSERT_GT(rest, mpv_allocator.GetCount());     // mpv_allocatorのメモリが減っていることの確認

これまでの手法を組み合わせ下記のようにすることで、 std::stringと同等のオブジェクトを保持するstd::vectorを宣言することもできる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 72

    using mpv_vector_str = std::vector<mpv_string, MPoolBasedAllocator<mpv_string>>;

    template <>
    MPool& MPoolBasedAllocator<mpv_string>::mpool_ = mpv_allocator;
    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 94

    auto strs = mpv_vector_str{"1", "2", "3"};

    ASSERT_GT(rest, mpv_allocator.GetCount());

    for (auto const& s : strs) {
        ASSERT_TRUE(mpv_allocator.IsValid(&s));         // mpv_allocatorのメモリであることの確認
        ASSERT_TRUE(mpv_allocator.IsValid(s.c_str()));  // mpv_allocatorのメモリであることの確認
    }

しかし、下記に示すように、これまでの定義、 宣言のみではmpv_stringのnewにこのアロケータを使わせることはできない。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 121

    auto rest = mpv_allocator.GetCount();

    auto str0 = std::make_unique<mpv_string>();  // グローバルnewが使われる

    // mpv_stringのnewにはmpv_allocatorは使われない
    ASSERT_FALSE(mpv_allocator.IsValid(str0.get()));
    ASSERT_EQ(rest, mpv_allocator.GetCount());

そうするためには、さらに下記のような定義が必要になる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 108

    struct mpv_string_op_new : OpNew<mpv_string_op_new>, mpv_string {
        using mpv_string::basic_string;
    };

    template <>
    MPool& OpNew<mpv_string_op_new>::mpool_ = mpv_allocator;

このようにすることで、下記に示すように期待した動きになる。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 133

    rest = mpv_allocator.GetCount();

    auto str1 = std::make_unique<mpv_string_op_new>();

    // mpv_string_op_newのnewにmpv_allocatorが使われる
    ASSERT_TRUE(mpv_allocator.IsValid(str1.get()));
    ASSERT_GT(rest, mpv_allocator.GetCount());

ただし、std::make_sharedを使用した場合、この関数のメモリアロケーションの最適化により、 下記に示すように期待した結果にならないため、注意が必要である。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 145

    rest = mpv_allocator.GetCount();

    auto str2 = std::make_shared<mpv_string_op_new>();

    // mpv_string_op_newのnewにmpv_allocatorが使われない!!!
    ASSERT_FALSE(mpv_allocator.IsValid(str2.get()));
    ASSERT_EQ(rest, mpv_allocator.GetCount());

newをオーバーロードしたクラスをstd::shared_ptrで管理する場合、下記のようにしなければならない。

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 157

    rest = mpv_allocator.GetCount();

    auto str3 = std::shared_ptr<mpv_string_op_new>{new mpv_string_op_new};

    // mpv_string_op_newのnewにmpv_allocatorが使われる
    ASSERT_TRUE(mpv_allocator.IsValid(str3.get()));
    ASSERT_GT(rest, mpv_allocator.GetCount());

デバッグ用イテレータ

可変長メモリプールを使用すると、 メモリのフラグメントによりアロケーションが失敗することがあり得る。 このような事態が発生している可能性がある場合、 アロケータが保持しているメモリの状態を表示させることがデバッグの第一歩となる。

下記のコードは、そのためのインターフェースを提供する。

    //  example/dynamic_memory_allocation/mpool_variable.h 59

    template <uint32_t MEM_SIZE>
    class MPoolVariable final : public MPool {
    public:

        // 中略
        ...

        class const_iterator {
        public:
            explicit const_iterator(Inner_::header_t const* header) noexcept : header_{header} {}
            const_iterator(const_iterator const&) = default;
            const_iterator(const_iterator&&)      = default;

            const_iterator& operator++() noexcept  // 前置++のみ実装
            {
                assert(header_ != nullptr);
                header_ = header_->next;

                return *this;
            }

            Inner_::header_t const* operator*() noexcept { return header_; }


        #if __cplusplus <= 201703L  // c++17
            bool operator==(const_iterator const& rhs) noexcept { return header_ == rhs.header_; }
            bool operator!=(const_iterator const& rhs) noexcept { return !(*this == rhs); }
        #else  // c++20

            auto operator<=>(const const_iterator&) const = default;
        #endif

        private:
            Inner_::header_t const* header_;
        };

        const_iterator begin() const noexcept { return const_iterator{header_}; }
        const_iterator end() const noexcept { return const_iterator{nullptr}; }
        const_iterator cbegin() const noexcept { return const_iterator{header_}; }
        const_iterator cend() const noexcept { return const_iterator{nullptr}; }

        // 中略
        ...
    };

このインターフェースを下記のように使用することで、

    //  example/dynamic_memory_allocation/mpool_allocator_ut.cpp 213

    for (auto mem : mpv_allocator) {
        std::cout << std::setw(16) << mem->next << ":" << mem->n_nuits << std::endl;
    }

下記のようにmpv_allocator.header_が保持するメモリの現在の状態を見ることができる (これによるとmpv_allocatorが保持するメモリの先頭付近では多少フラグメントを起こしているが、 最後に大きなメモリブロックがあるため、全体としては問題ないレベルである)。

        0x7f073afe59d0:3
        0x7f073afe5a60:3
        0x7f073afe5ac0:3
        0x7f073afe5b70:3
        0x7f073afe5c50:11
        0x7f073afe5cb0:3
        0x7f073afe5e50:13
                     0:4018

グローバルnew/deleteのオーバーロードの実装」でも述べたように、 デバッグ用入出力機能からこのような出力を得られるようにしておくべきである。

エクセプション処理機構の変更

多くのコンパイラのエクセプション処理機構にはnew/deleteやmalloc/freeが使われているため、 リアルタイム性が必要な個所でエクセプション処理を行ってはならない。 そういった規制でプログラミングを行っていると、 リアルタイム性が不要な処理であるため使用しているSTLコンテナにすら、 既存のエクセプション処理機構を使わせたく無くなるものである。

コンパイラにg++clang++を使っている場合、 下記関数を置き換えることでそういった要望を叶えることができる。

関数 機能
__cxa_allocate_exception(size_t thrown_size) エクセプション処理用のメモリ確保
__cxa_free_exception(void\* thrown_exception) 上記で確保したメモリの解放

オープンソースであるstatic exceptionを使うことで、 上記2関数を置き換えることもできるが、この実装が複雑すぎると思うのであれば、 下記に示すような、これまで使用したMPoolFixedによる単純な実装を使うこともできる。

    //  example/dynamic_memory_allocation/exception_allocator_ut.cpp 15

    // https://github.com/hjl-tools/gcc/blob/master/libstdc%2B%2B-v3/libsupc%2B%2B/unwind-cxx.h
    // の抜粋
    namespace __cxxabiv1 {
    struct __cxa_exception {
        // ...
    };
    SUPPRESS_WARN_END;
    }  // namespace __cxxabiv1

    namespace {

    constexpr size_t             offset{sizeof(__cxxabiv1::__cxa_exception)};
    MPoolFixed<offset + 128, 50> mpf_exception;
    }  // namespace

    extern "C" {

    void* __cxa_allocate_exception(size_t thrown_size)
    {
        auto alloc_size = thrown_size + offset;  // メモリの実際の必要量はthrown_size+offset
        auto mem        = mpf_exception.AllocNoExcept(alloc_size);

        assert(mem != nullptr);

        memset(mem, 0, alloc_size);
        auto* ret = static_cast<uint8_t*>(mem);

        ret += offset;

        return ret;
    }

    void __cxa_free_exception(void* thrown_exception)
    {
        auto* ret = static_cast<uint8_t*>(thrown_exception);

        ret -= offset;
        mpf_exception.Free(ret);
    }

以下に単体テストを示す。

    //  example/dynamic_memory_allocation/exception_allocator_ut.cpp 104

    auto count             = mpf_exception.GetCount();
    auto exception_occured = false;

    try {
        throw std::exception{};
    }
    catch (std::exception const& e) {
        ASSERT_EQ(count - 1, mpf_exception.GetCount());  // 1個消費
        exception_occured = true;
    }

    ASSERT_TRUE(exception_occured);
    ASSERT_EQ(count, mpf_exception.GetCount());  // 1個解放

すでに述べたが、残念なことに、この方法はC++の標準外であるため、 これを適用できるコンパイラは限られている。 しかし、多くのコンパイラはこれと同様の拡張方法を備えているため、 安易にエクセプションやSTLコンテナを使用禁止することなく、安全に使用する方法を探るべきだろう。

Polymorphic Memory Resource(pmr)

Polymorphic Memory Resource(pmr)は、 動的メモリ管理の柔軟性と効率性を向上させるための、C++17から導入された仕組みである。

C++17で導入されたstd::pmr名前空間は、カスタマイズ可能なメモリ管理を提供し、 特にSTLコンテナと連携して効率化を図るための統一フレームワークを提供する。 std::pmrは、 カスタマイズ可能なメモリ管理を標準ライブラリのデータ構造に統合するための統一的なフレームワークであり、 特にSTLコンテナと連携して、動的メモリ管理を効率化することができる。

std::pmrは以下のようなメモリ管理のカスタマイズを可能にする。

std::pmrの主要なコンポーネントは以下の通りである。

std::pmr::memory_resource

std::pmr::memory_resourceは、 ユーザー定義のメモリリソースをカスタマイズし、 std::pmr::polymorphic_allocatorを通じて利用可能にするインターフェースクラスである。

可変長メモリプールの実装で示したコードとほぼ同様の、 std::pmr::memory_resourceから派生した具象クラスの実装を以下に示す。

    //  example/dynamic_memory_allocation/pmr_memory_resource_ut.cpp 64

    template <uint32_t MEM_SIZE>
    class memory_resource_variable final : public std::pmr::memory_resource {
    public:
        memory_resource_variable() noexcept
        {
            header_->next    = nullptr;
            header_->n_nuits = sizeof(buff_) / Inner_::unit_size;
        }

        size_t get_count() const noexcept { return unit_count_ * Inner_::unit_size; }
        bool   is_valid(void const* mem) const noexcept
        {
            return (&buff_ < mem) && (mem < &buff_.buffer[ArrayLength(buff_.buffer)]);
        }

        // ...

    private:
        using header_t = Inner_::header_t;

        Inner_::buffer_t<MEM_SIZE> buff_{};
        header_t*                  header_{reinterpret_cast<header_t*>(buff_.buffer)};
        mutable SpinLock           spin_lock_{};
        size_t                     unit_count_{sizeof(buff_) / Inner_::unit_size};
        size_t                     unit_count_min_{sizeof(buff_) / Inner_::unit_size};

        void* do_allocate(size_t size, size_t) override
        {
            // MPoolVariable::allocとほぼ同じ
            // ...
        }

        void do_deallocate(void* mem, size_t, size_t) noexcept override
        {
            // MPoolVariable::freeとほぼ同じ
            // ...
        }

        bool do_is_equal(const memory_resource& other) const noexcept override { return this == &other; }
    };

std::pmr::polymorphic_allocator

std::pmr::polymorphic_allocatorはC++17で導入された標準ライブラリのクラスで、 C++のメモリリソース管理を抽象化するための機能を提供する。 std::pmr::memory_resourceを基盤とし、 コンテナやアルゴリズムにカスタムメモリアロケーション戦略を容易に適用可能にする。 std::allocatorと異なり、型に依存せず、 ポリモーフィズムを活用してメモリリソースを切り替えられる点が特徴である。

すでに示したmemory_resource_variable(std::pmr::memory_resource)の単体テストを以下に示すことにより、 polymorphic_allocatorの使用例とする。

    //  example/dynamic_memory_allocation/pmr_memory_resource_ut.cpp 214

    constexpr uint32_t            max = 1024;
    memory_resource_variable<max> mrv;
    memory_resource_variable<max> mrv2;

    ASSERT_EQ(mrv, mrv);
    ASSERT_NE(mrv, mrv2);

    {
        auto remaings1 = mrv.get_count();

        ASSERT_GE(max, remaings1);

        // std::basic_stringにカスタムアロケータを適用
        using pmr_string = std::basic_string<char, std::char_traits<char>, std::pmr::polymorphic_allocator<char>>;
        std::pmr::polymorphic_allocator<char> allocator(&mrv);

        // カスタムアロケータを使って文字列を作成
        pmr_string str("custom allocator!", allocator);
        auto       remaings2 = mrv.get_count();
        // アサーション: 文字列の内容を確認

        ASSERT_GT(remaings1, remaings2);
        ASSERT_EQ("custom allocator!", str);

        ASSERT_TRUE(mrv.is_valid(str.c_str()));  // strの内部メモリがmrvの内部であることの確認

        auto str3 = str + str + str;
        ASSERT_EQ(str.size() * 3 + 1, str3.size() + 1);
        ASSERT_THROW(str3 = pmr_string(2000, 'a'), std::bad_alloc);  // メモリの枯渇テスト
    }

    ASSERT_GE(max, mrv.get_count());  // 解放後のメモリの回復のテスト

pool_resource

pool_resourceはstd::pmr::memory_resourceを基底とする下記の2つの具象クラスである。

    //  example/dynamic_memory_allocation/pool_resource_ut.cpp 10

    std::pmr::unsynchronized_pool_resource pool_resource(
        std::pmr::pool_options{
            .max_blocks_per_chunk        = 10,   // チャンクあたりの最大ブロック数
            .largest_required_pool_block = 1024  // 最大ブロックサイズ
        },
        std::pmr::new_delete_resource()  // フォールバックリソース
    );

    // vectorを使用したメモリ割り当てのテスト
    {
        std::pmr::vector<int> vec{&pool_resource};

        // ベクターへの要素追加
        vec.push_back(42);
        vec.push_back(100);

        // メモリ割り当てと要素の検証
        ASSERT_EQ(vec.size(), 2);
        ASSERT_EQ(vec[0], 42);
        ASSERT_EQ(vec[1], 100);
    }
    //  example/dynamic_memory_allocation/pool_resource_ut.cpp 38

    std::pmr::synchronized_pool_resource shared_pool;

    auto thread_func = [&shared_pool](int thread_id) {
        std::pmr::vector<int> local_vec{&shared_pool};

        // スレッドごとに異なる要素を追加
        local_vec.push_back(thread_id * 10);
        local_vec.push_back(thread_id * 20);

        ASSERT_EQ(local_vec.size(), 2);
    };

    // 複数スレッドでの同時使用
    std::thread t1(thread_func, 1);
    std::thread t2(thread_func, 2);

    t1.join();
    t2.join();

用語解説

この章では、このドキュメントで使用する用語の解説をする。


この章の構成

   組み込み型とインスタンス
    基本型
    組み込み型
    算術型
    汎整数型
    整数型
    算術変換
    汎整数型昇格
    汎整数型拡張
    浮動小数点型昇格
    デフォルト引数昇格
    縮小型変換
    浮動小数点型
     浮動小数点型のダイナミックレンジ
     浮動小数点の誤差
     イプシロン
     浮動小数点の演算エラー

   enum
    enum class
    スコープドenum
    underlying type
    std::byte
    using enum

   型とインスタンス
    特殊メンバ関数
     ゼロの原則(Rule of Zero)
     五の原則(Rule of Five)

    トリビアル型
    トリビアルに破壊可能な型
    標準レイアウト型
    集成体
    POD
    不完全型
    完全型
    ポリモーフィックなクラス
    オーバーライドとオーバーロードの違い
    RTTI
     dynamic_cast
     typeid
     std::type_info

    Run-time Type Information
    インターフェースクラス
    constインスタンス

   constexpr
    constexpr定数
    constexpr関数
    コア定数式
    リテラル型
    constexprインスタンス
    consteval
    constexprラムダ

   オブジェクトと生成
    リスト初期化
    一様初期化
    初期化子リストコンストラクタ
    継承コンストラクタ
    委譲コンストラクタ
    非静的なメンバ変数の初期化
     NSDMI
     初期化子リストでの初期化
     コンストラクタ内での非静的なメンバ変数の初期値の代入

    オブジェクトの所有権
     オブジェクトの排他所有
     オブジェクトの共有所有
     オブジェクトの循環所有
     std::weak_ptr

    オブジェクトのライフタイム
    オブジェクトのコピー
     シャローコピー
     ディープコピー
     スライシング

   リテラル
    生文字列リテラル
    2進数リテラル
    数値リテラル
    ワイド文字列
    16進浮動小数点数リテラル
    ユーザー定義リテラル
     ユーザ定義リテラル演算子
     std::string型リテラル
     std::chronoのリテラル
     std::complexリテラル

    ==演算子
     メンバ==演算子
     非メンバ==演算子

    比較演算子
     std::rel_ops
     std::tuppleを使用した比較演算子の実装方法
     <=>演算子
     三方比較演算子
     spaceship operator

   構文
    属性構文
    関数tryブロック
    範囲for文
    構造化束縛
    初期化付きif/switch文
     初期化付きfor文(従来のfor文)
     初期化付きwhile文(従来のwhile文)
     初期化付きif文
     初期化付きswitch文

   言語機能
    コルーチン
     co_await
     co_return
     co_yield

    モジュール
    ラムダ式
     クロージャ
     クロージャ型
     一時的ラムダ
     transient lambda

    指示付き初期化

   プログラミング概念と標準ライブラリ
    スマートポインタ
    コンテナ
     シーケンスコンテナ(Sequence Containers)
     連想コンテナ(Associative Containers)
     無順序連想コンテナ(Unordered Associative Containers)
     コンテナアダプタ(Container Adapters)
     特殊なコンテナ

    std::optional
     戻り値の無効表現
     オブジェクトの遅延初期化

    std::variant

   name lookupと名前空間
    ルックアップ
    name lookup
    two phase name lookup
    実引数依存探索
    ADL
    関連名前空間
    修飾付き関数呼び出し
    hidden-friend関数
    name-hiding
    ダイヤモンド継承
    仮想継承
    仮想基底
    ドミナンス
     ダイヤモンド継承を含まない場合
     ダイヤモンド継承かつそれが仮想継承でない場合
     ダイヤモンド継承かつそれが仮想継承である場合

    using宣言
    usingディレクティブ

   template強化機能
    SFINAE
    コンセプト
    畳み込み式
    ジェネリックラムダ
    クラステンプレートのテンプレート引数の型推論
    テンプレートの型推論ガイド
    CTAD(Class Template Argument Deduction)
    変数テンプレート
    エイリアステンプレート
    constexpr if文
    autoパラメータによる関数テンプレートの簡易定義

   型推論
    AAAスタイル
    decltype
    decltype(auto)
    CTAD(Class Template Argument Deduction)
    戻り値型を後置する関数宣言
    関数の戻り値型auto
    後置戻り値型auto

   explicit
    暗黙の型変換
    暗黙の型変換抑止
    explicit type operator()
    explicit(COND)

   expressionと値カテゴリ
    expression
     lvalue
     rvalue
     xvalue
     prvalue
     glvalue

    decltypeとexpression

   リファレンス
    lvalueリファレンス
    rvalueリファレンス
     lvalueからの代入
     rvalueからの代入
     std::move(lvalue)からの代入

    forwardingリファレンス
    ユニバーサルリファレンス
    perfect forwarding
    リファレンスcollapsing
    danglingリファレンス
    danglingポインタ

   リファレンス修飾
    rvalue修飾
    lvalue修飾

   エクセプション安全性の保証
    no-fail保証
    強い安全性の保証
    基本的な安全性の保証
    noexcept
    exception-unfriendly

   シンタックス、セマンティクス
    等価性のセマンティクス
    copyセマンティクス
    moveセマンティクス
    MoveAssignable要件
    CopyAssignable要件

   C++その他
    型特性キーワード
     alignof
     alignas
     addressof

    演算子のオペランドの評価順位
    実引数/仮引数
    単純代入
    ill-formed
    well-formed
    未定義動作
    未規定動作
    未定義動作と未規定動作
    被修飾型
    one-definition rule
    ODR
    RVO(Return Value Optimization)
    SSO(Small String Optimization)
    heap allocation elision
    Most Vexing Parse
    トライグラフ

   C++コンパイラ
    g++
    clang++

   ソフトウェア一般
    ハンドル
    フリースタンディング環境
    サイクロマティック複雑度
    凝集度
     凝集度の欠如
     LCOMの評価基準

    Spurious Wakeup
    副作用
    is-a
    has-a
    is-implemented-in-terms-of
     public継承によるis-implemented-in-terms-of
     private継承によるis-implemented-in-terms-of
     コンポジションによる(has-a)is-implemented-in-terms-of

   非ソフトウェア用語
    割れ窓理論
    車輪の再発明

このドキュメントの構成に戻る。


組み込み型とインスタンス

基本型

基本型(fundamental types)は、C++の標準で定義されている型で、 特別なキーワードを使用して直接宣言できる型の総称である。 組み込み型とも呼ばれることもある。

基本型は以下のに示した型によって構成される。

注:
リファレンスは基本型に含まれない。

組み込み型

組み込み型(built-in types)は基本型(fundamental types)の別称。

算術型

算術型とは下記の型の総称である。

算術型のサイズは下記のように規定されている。

汎整数型

汎整数型とは下記の型の総称である。

整数型

整数型とは下記の型の総称である。

算術変換

C++における算術変換とは、算術演算の1つのオペランドが他のオペランドと同じ型でない場合、 1つのオペランドを他のオペランドと同じ型に変換するプロセスのことを指す。

算術変換は、汎整数型昇格と通常算術変換に分けられる。

    //  example/term_explanation/integral_promotion_ut.cpp 11

    bool           bval{};
    char           cval{};
    short          sval{};
    unsigned short usval{};
    int            ival{};
    unsigned int   uival{};
    long           lval{};
    unsigned long  ulval{};
    float          fval{};
    double         dval{};

    auto ret_0 = 3.14159 + 'a';  // 'a'は汎整数拡張でintになった後、さらに通常算術変換でdoubleに
    static_assert(std::is_same<decltype(ret_0), double>::value, "");

    auto ret_1 = dval + ival;  // ivalは通常算術変換でdoubleに
    static_assert(std::is_same<decltype(ret_1), double>::value, "");

    auto ret_2 = dval + fval;  // fvalは通常算術変換でdoubleに
    static_assert(std::is_same<decltype(ret_2), double>::value, "");

    auto ret_3 = ival = dval;  // dvalは通常算術変換でintに
    static_assert(std::is_same<decltype(ret_3), int>::value, "");

    bval = dval;  // dvalは通常算術変換でboolに
    ASSERT_FALSE(bval);

    auto ret_4 = cval + fval;  // cvalは汎整数拡張でintになった後、さらに通常算術変換でfloatに
    static_assert(std::is_same<decltype(ret_4), float>::value, "");

    auto ret_5 = sval + cval;  // svalとcvalは汎整数拡張でintに
    static_assert(std::is_same<decltype(ret_5), int>::value, "");

    auto ret_6 = cval + lval;  // cvalはは汎整数拡張でintになった後、通常算術変換でlongに
    static_assert(std::is_same<decltype(ret_6), long>::value, "");

    auto ret_7 = ival + ulval;  // ivalは通常算術変換でunsigned longに
    static_assert(std::is_same<decltype(ret_7), unsigned long>::value, "");

    auto ret_8 = usval + ival;  // usvalは汎整数拡張でintに
                                // ただし、この変換はunsigned shortとintのサイズに依存する
    static_assert(std::is_same<decltype(ret_8), int>::value, "");

    auto ret_9 = uival + lval;  // uivalは通常算術変換でlongに
                                // ただし、この変換はunsigned intとlongのサイズに依存する
    static_assert(std::is_same<decltype(ret_9), long>::value, "");

一様初期化を使用することで、 変数定義時の算術変換による意図しない値の変換(縮小型変換)を防ぐことができる。

    //  example/term_explanation/integral_promotion_ut.cpp 62

    int i{-1};
    // int8_t i8 {i};  縮小型変換によりコンパイル不可
    int8_t i8 = i;  // intからint8_tへの型変換
    // これには問題ないが

    ASSERT_EQ(-1, i8);

    // uint8_t ui8 {i};  縮小型変換によりコンパイル不可
    uint8_t ui8 = i;  // intからuint8_tへの型変換
    // おそらく意図通りではない

    ASSERT_EQ(255, ui8);

以下に示すように、算術変換の結果は直感に反することがあるため、注意が必要である。

    //  example/term_explanation/integral_promotion_ut.cpp 81

    int          i{-1};
    unsigned int ui{1};

    // ASSERT_TRUE(i < ui);
    ASSERT_TRUE(i > ui);  // 算術変換の影響で、-1 < 1が成立しない

    signed short   s{-1};
    unsigned short us{1};

    ASSERT_TRUE(s < us);  // 汎整数拡張により、-1 < 1が成立

汎整数型昇格

bool、char、signed char、unsigned char、short、unsigned short型の変数が、 算術のオペランドとして使用される場合、

この変換を汎整数型昇格(integral promotion)と呼ぶ。

従って、sizof(short) < sizeof(int)である処理系では、 bool、char、signed char、unsigned char、short、unsigned short型の変数は、 下記のようにintに変換される。

    //  example/term_explanation/integral_promotion_ut.cpp 100

    bool bval;
    static_assert(std::is_same<int, decltype(bval + bval)>::value, "");

    char cval;
    static_assert(std::is_same<int, decltype(cval + cval)>::value, "");

    unsigned char ucval = 128;
    static_assert(std::is_same<int, decltype(ucval + ucval)>::value, "");
    ASSERT_EQ(256, ucval + ucval);  // 汎整数拡張により256になる

    static_assert(std::is_same<int, decltype(cval + ucval)>::value, "");

    short sval;
    static_assert(std::is_same<int, decltype(sval + sval)>::value, "");

    unsigned short usval;
    static_assert(std::is_same<int, decltype(usval + usval)>::value, "");

    static_assert(std::is_same<int, decltype(sval + usval)>::value, "");

汎整数型拡張

汎整数型拡張とは汎整数型昇格と同じ概念を指す。

浮動小数点型昇格

浮動小数点型昇格とは、float型とdouble型の演算で、 float型オブジェクトがdoulbe型に変換されることを指す。

    //  example/term_explanation/integral_promotion_ut.cpp 126

    double d = 0.05;  // 0.05は循環少数
    float  f = 0.05f;

    bool b1 = d == f;  // fはdoubleに昇格
    ASSERT_FALSE(b1);  // 0.05は循環少数であるため、0.5と0.5fは異なる。

    bool b2 = std::abs(d - f) <= std::numeric_limits<decltype(d - f)>::epsilon();
    ASSERT_FALSE(b2);  // dとfの差はdoubleのイプシロンには収まらない。

デフォルト引数昇格

デフォルト引数昇格(Default Argument Promotions)とは、可変長引数(...)や、 プロトタイプを持たない関数に算術型引数を渡す際に適用される昇格ルールの総称である。

デフォルト引数昇格には以下が含まれる。

縮小型変換

縮小型変換(Narrowing Conversion) とは、あるデータ型から別のデータ型に変換する際に、 変換先の型が元の型の表現範囲を完全にカバーしていない場合に発生する変換を指す。 主に整数型浮動小数点型などの値を小さな範囲の型に変換する際に起こる。

    //  example/term_explanation/etc_ut.cpp 43

    int32_t large  = 300;
    int8_t  small  = large;  // 縮小型変換
    bool    b      = large;
    double  d      = large;  // 単単なる型変換(縮小ではない)
    int32_t large2 = d;      // 縮小型変換

    // large = int32_t{d};   縮小型変換回避のためリスト初期化の使用。コンパイルエラー

リスト初期化を使うことで、このような変換によるバグの発生を防ぐことができる。

浮動小数点型

浮動小数点型は以下の型の総称である。

浮動小数点の仕様は、IEEE 754標準に準拠している。 この標準は、浮動小数点演算の表現方法、精度、丸め方法、および例外処理を規定しており、 広く使用されている。

浮動小数点型のダイナミックレンジ

正の最小値 正の最大値
float 1.175494351 e-38 3.402823466 e+38
double 2.2250738585072014 e-308 1.7976931348623158 e+308
long double 3.36210314311209350626 e-4932 1.18973149535723176502 e+4932
int32_t -2,147,483,648 2,147,483,647
int64_t -9,223,372,036,854,775,808 9,223,372,036,854,775,807

ここでlong doubleの最小値と最大値は、システムやコンパイラに依存して異なる場合がある点に留意する。

浮動小数点の誤差

浮動小数点変数の10進数の表現が2進数では循環小数となる場合があり、 正確に表現できないことがある。これにより、計算結果がわずかに異なる値を返す場合がある。 浮動小数点誤差は、特に計算の繰り返しや桁数の多い計算で顕著になる。

以下のコードにより誤差が容易に発生することを示す。

    //  example/term_explanation/float_ut.cpp 12

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    //  ASSERT_EQ(0.05F, a + b);  // NG  a + b == 0.05Fは一般には成立しない。
    ASSERT_NE(0.05F, a + b);

イプシロン

イプシロン(epsilon)とは、ある浮動小数点数に対して「1」を加えた時に、 異なる値として識別できる最小の差分を指す。 つまり、イプシロンは浮動小数点数の精度を示す尺度である。

任意の浮動小数点変数a, bがあり、|a - b| <= epsilonであった場合、 浮動小数点の仕組みではa、bの差が無いものと考えて、aとbが同値であると考えることが一般的である。

イプシロンを使用した浮動小数点変数の同値判定のコード例を以下に示す。

    //  example/term_explanation/float_ut.cpp 24

    // 下記の0.01は2進数では循環小数となるため、実数の0.01とは異なる。
    constexpr auto a = 0.01F;  // 0.0000001010001111...
    constexpr auto b = 0.04F;  // 0.0000101000111101...

    bool is_equal = 0.05F == (a + b);
    ASSERT_FALSE(is_equal);  // is_equalはtrueにはならない

    bool is_nearly_equal = std::abs(0.05F - (a + b)) <= std::numeric_limits<float>::epsilon();
    ASSERT_TRUE(is_nearly_equal);  // 浮動小数点の同値はこのように判定する

浮動小数点の演算エラー

浮動小数点の演算は以下のようなエラーを生じることがある。

エラーの種類 説明
丸め誤差 有限桁数による四捨五入の誤差が発生し、正確な値とわずかに異なる場合がある。 0.1 + 0.2 != 0.3
桁落ち 非常に小さい数と大きい数の加算時に、小さい数が無視され、精度が低下する。 1e20 + 1 - 1e20 == 0
累積誤差 繰り返し演算で小さな誤差が積み重なり、最終的に大きなズレが生じることがある。 ループ内での浮動小数点の加算
ゼロ除算 0での除算により計算が定義されず、例外が発生または±無限大が返される。 1.0 / 0.0
オーバーフロー 型が表現可能な最大値を超えると無限大(inf)として扱われる。 std::pow(10.0, 308)
アンダーフロー 型の最小値より小さい数値は0または非常に小さな値として表現され、精度が失われる。 std::pow(10.0, -308)
NaN 実数では表現できない。 std::sqrt(-1)

浮動小数点の演算エラーの検出コード例を以下に示す。

    //  example/term_explanation/float_ut.cpp 43

    std::feclearexcept(FE_ALL_EXCEPT);  // エラーをクリア

    div(1.0F, 0.0F);  // 関数の中で0除算するが、終了シグナルは発生しない
    ASSERT_TRUE(std::fetestexcept(FE_ALL_EXCEPT) & FE_DIVBYZERO);  // 0除算

    std::feclearexcept(FE_ALL_EXCEPT);  // エラーをクリア

    div(std::numeric_limits<double>::max(), 1);

    auto const excepts = std::fetestexcept(FE_ALL_EXCEPT);

    ASSERT_FALSE(excepts & FE_DIVBYZERO);  // 0除算
    ASSERT_TRUE(excepts & FE_INEXACT);     // 演算が不正確
    ASSERT_FALSE(excepts & FE_INVALID);    // 不正な操作
    ASSERT_TRUE(excepts & FE_OVERFLOW);    // 演算がオーバーフローを起こした
    ASSERT_FALSE(excepts & FE_UNDERFLOW);  // 演算がアンダーフローを起こした

    std::feclearexcept(FE_ALL_EXCEPT);  // エラーをクリア

    auto const a = 1.0F / global_zero;  // global_zero == 0
    ASSERT_TRUE(std::isinf(a));

    auto const b = std::sqrt(-1);
    auto const c = std::sqrt(-1);
    ASSERT_TRUE(std::isnan(b));
    ASSERT_FALSE(b == c);  // NaN == NaNは常にfalse

なお、上記のコードで使用したstd::fetestexceptは一般にスレッドセーフである。 std::fetestexceptがスレッドセーフでない処理系では、浮動小数演算エラーの検出は、 実質的には不可能になってしまうため、 浮動小数演算を複数コンテキストで行うソフトウェアの開発する場合、 処理系の選択に注意が必要である。

enum

C++03までのenumは定数を分かりやすい名前で定義するための記法である。 このドキュメントでは、スコープドenumに対して、C++03までのenumを非スコープドenum、 通常のenum、あるいは単にenumと呼ぶことがある。 C++03までのenumには、以下のような問題があった。

    //  example/term_explanation/enum_ut.cpp 14

    enum DayOfWeek { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday };

    ASSERT_TRUE(1 == Monday);  // intへの暗黙の変換

    enum Color { Red, Green, Blue };

    ASSERT_TRUE(Green == Monday);  // 別のenumが比較できてしまう

enum class

enum classは通常のenumの問題を解決するためにC++11から導入された。

    //  example/term_explanation/enum_ut.cpp 29

    enum class DayOfWeek { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday };

    // ASSERT_TRUE(1 == Monday);  // intへの暗黙の変換できないため、コンパイルエラー
    ASSERT_TRUE(1 == static_cast<int>(DayOfWeek::Monday));

    enum class Color { Red, Green, Blue };

    // ASSERT_TRUE(Green == Monday);  // 別のenumが比較できないため、コンパイルエラー
    ASSERT_TRUE(static_cast<DayOfWeek>(Color::Green) == DayOfWeek::Monday);
    //  example/term_explanation/enum_ut.cpp 41

    // DayOfWeek d0 {0}; intからの暗黙の型変換は許可されないため、コンパイルエラー
    DayOfWeek d0{static_cast<DayOfWeek>(0)};
    DayOfWeek d1{};  // デフォルト初期化
    ASSERT_EQ(d1, DayOfWeek::Sunday);

    DayOfWeek d2{DayOfWeek::Tuesday};  // 値あり初期化

スコープドenum

enum classはスコープドenum(scoped enum)と呼ばれることがある。

underlying type

underlying typeとは、enumやenum classの汎整数型を指定できるようにするために、 C++11で導入されたシンタックスである。enumのサイズをユーザが定義できるため、 特定のバイナリプロトコルとの互換性が必要な場合や、特定のハードウェアと連携する際に特に有効である。

    //  example/term_explanation/enum_ut.cpp 54

    enum NormalEnum {  // underlying typeの指定しない従来のenum
    };

    enum NormalEnumUnderlyingType : int8_t {  // enum underlying typeがint8_tに指定された従来のenum
    };

    // enum class
    enum class EnumClass {  // underlying typeの指定しないenum class
    };

    enum class EnumClassUnderlyingType : int64_t {  // enum underlying typeがint64_tに指定されたenum
                                                    // class
    };

    static_assert(4 ==  sizeof(NormalEnum));  // 列挙子の値を表現するのに十分なサイズの整数型で処理系依存
    static_assert(4 ==  sizeof(EnumClass));   // 列挙子の値を表現するのに十分なサイズの整数型で処理系依存
    static_assert(sizeof(int8_t) == sizeof(NormalEnumUnderlyingType));
    static_assert(sizeof(int64_t) == sizeof(EnumClassUnderlyingType));

C++17までは、型安全の観点から、初期化においては、以下のコードコメントのような仕様であったが、 C++17から導入されたstd::byteの利便性のため、 underlying typeを指定したenumやenum class変数のunderlying typeインスタンスによる初期化が認められるようになった。

    //  example/term_explanation/enum_ut.cpp 80

    enum class Color : int { Red, Green, Blue };

    // Color red{0}; C++14まではコンパイルエラー

    Color red{0};  // underlying typeの効果でC++17からコンパイルできる。

    long a{1};
    // Color green{a};  // 縮小型変換が発生するため、コンパイルエラー

上記コードにもあるが、underlying typeインスタンスによる初期化を行う場合は、 意図しない縮小型変換によるバグの発生を防ぐためにも、 一様初期化を使用するべきだろう。

一部の例外を除くとunderlying typeを指定しないenumやenum classはコンパイル時にサイズが確定できないため、 前方宣言できないが、underlying typeを指定したenum、enum classは前方宣言することができる。

    //  example/term_explanation/enum_ut.cpp 97

    // in calender.h
    enum class DayOfWeek : int8_t;  // DayOfWeekの前方宣言

    bool calender(DayOfWeek);  // 前方宣言の効果でこのヘッダでの#include "day_of_week.h"が不要

    // in day_of_week.h
    enum class DayOfWeek : int8_t { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday };

std::byte

C++17で導入されたstd::byte型は、バイト単位のデータ操作に使用され、 整数型としての意味を持たないため、型安全性を確保する。 uint8_t型と似ているが、uint8_t型の演算による汎整数型昇格を発生させないため、 可読性、保守性の向上が見込める。

    //  example/term_explanation/enum_ut.cpp 113

    uint8_t u8_0     = 0x80;
    auto    result_0 = u8_0 << 1;  // 汎整数拡張のためresult_0の型はintになる

    static_assert(std::is_same_v<decltype(result_0), int>);
    ASSERT_EQ(0x100, result_0);  // これがわかりずらいバグにつながることがある

    auto u8_1     = std::byte{0x80};
    auto result_1 = u8_1 << 1;  // 汎整数拡張は発生せず、result_1の型はstd::byteになる

    static_assert(std::is_same_v<decltype(result_1), std::byte>);

    // 整数型を取り出すためには、暗黙の型変換ではなく、
    // 明示的なto_integerの呼び出しが必要になることもコードの安全性につながる
    ASSERT_EQ(0x00, std::to_integer<int>(result_1));  // 0x100はstd::byteでは0

using enum

名前空間のように、

    using enum EnumType;

もしくは

    using EnumType::enumerator

とすることで、スコープによる修飾を省略するための記法である。

    //  example/term_explanation/enum_ut.cpp 158

    enum class Color { Red, Green, Yellow };

    constexpr std::string_view to_str(Color color)
    {
    #if __cplusplus >= 202002L  // c++20
        using enum Color;       // 名前修飾の省略可能にする

        switch (color) {
        case Red:
            return "Red";
        case Green:
            return "Green";
        case Yellow:
            return "Yellow";
        }

    #else  // c++17
        switch (color) {
        case Color::Red:
            return "Red";
        case Color::Green:
            return "Green";
        case Color::Yellow:
            return "Yellow";
        }
    #endif
        assert(false);
        return "";
    }
    //  example/term_explanation/enum_ut.cpp 194

    #if __cplusplus >= 202002L  // c++20
        using Color::Red;  // Redに関しては名前修飾なしで使用する

        ASSERT_EQ("Red", to_str(Red));
        ASSERT_EQ("Yellow", to_str(Color::Yellow));

    #else  // c++17
        ASSERT_EQ("Red", to_str(Color::Red));
        ASSERT_EQ("Yellow", to_str(Color::Yellow));
    #endif
    //  example/term_explanation/enum_ut.cpp 213

    class Signal {
    public:
        enum class Color { Red, Green, Yellow };
        using enum Color;

        void Set(Color);

    private:
        // ...
    };
    //  example/term_explanation/enum_ut.cpp 229

    Signal s{};

    s.Set(Signal::Color::Red);  // 名前修飾が長すぎる感じがする
    s.Set(Signal::Red);         // using enum colorがあるために、簡潔に書ける

    using Signal::Red;  // Redに関しては名前修飾なしで使用する
                        // この記述によりこの名前空間でのRed識別子が使えなくなる
    s.Set(Red);

この記法は、簡潔に記述できるものの、一方では過度な使用は、 C++03までのenumが持っていた問題を再発生させてしまうため、 ブロックスコープ以外での使用に関しては控え目に使用するべきだろう。

型とインスタンス

特殊メンバ関数

特殊メンバ関数とは下記の関数を指す。

以下のメンバ関数は特殊関数ではないが、C++20から特殊関数と同様に=defaultとすることで自動生成される。

ユーザがこれらを一切定義しない場合、または一部のみを定義する場合、 コンパイラは、下記のテーブル等で示すルールに従い、特殊関数メンバの宣言、定義の状態を定める。

左1列目がユーザによる各関数の宣言を表し、2列目以降はユーザ宣言の影響による各関数の宣言の状態を表す。
下記表において、

user-defined default ctor dtor copy ctor copy assign move ctor move assign == <=>
undeclared = default = default = default = default = default = default undeclared undeclared
non-default ctor undeclared = default = default = default = default = default undeclared undeclared
default ctor - = default = default = default = default = default undeclared undeclared
dtor = default - = default = default = default = default undeclared undeclared
copy ctor = default = default - = default = default = default undeclared undeclared
copy assign = default = default = default - = default = default undeclared undeclared
move ctor = default = default = delete = delete - = default undeclared undeclared
move assign = default = default = delete = delete = default - undeclared undeclared
== - - - - - - - undeclared
<=> - - - - - - undeclared -

テーブル注

上記表より、下記のようなことがわかる。

これらの特殊メンバ関数に対しての設計のガイドラインには、以下のようなものがある。

この2つの原則(ガイドライン)の使い分けに関しては、

とすることで安全で保守性性の高いコードを設計できる。

ゼロの原則(Rule of Zero)

「ゼロの原則」は、リソース管理を直接クラスで行わず、 リソース管理を専門とするクラス (例: 標準ライブラリのRAII(scoped guard)クラス)に任せる設計ガイドラインを指す。 この法則に従うと、自身で特殊メンバ関数を定義する必要がななくなる。

    //  example/term_explanation/rule_of_zero_ut.cpp 9

    class RuleZero {
    public:
        RuleZero(std::list<std::string> const& strs, std::string const& s) : strs_{strs}, s_{s} {}
        std::list<std::string> const& GetStrs() const noexcept { return strs_; }
        std::string const&            GetStr() const noexcept { return s_; }

        // 特殊メンバ関数は、メンバの特殊メンバ関数に任せる
    private:
        std::list<std::string> strs_{};
        std::string            s_{};
    };
    //  example/term_explanation/rule_of_zero_ut.cpp 26

    auto z = RuleZero(std::list<std::string>{"1", "2", "3"}, "str");

    auto coied = z;             // コピーは自動生成に任せる(ゼロの原則)
    auto moved = std::move(z);  // ムーブも自動生成に任せる(ゼロの原則)

    ASSERT_EQ(coied.GetStr(), moved.GetStr());
    ASSERT_EQ(coied.GetStrs(), moved.GetStrs());

クラスがリソースを直接管理する場合、メモリリークや二重解放などのリスクを伴う。 上記のように信頼性の高いクラスに特殊メンバ関数の処理を任せることにより、 クラス自体にリソース管理の責任を持たせる必要がなくなる。

五の原則(Rule of Five)

「五の原則」は、 クラスがリソース(例: 動的メモリやファイルハンドルなど)を管理する場合、 デフォルトコンストラクタを除く特殊メンバ関数、 つまり以下の5つの関数をすべて適切に定義する必要があるという設計ガイドラインを指す。

特殊メンバ関数の挙動を正しく定義しないと、 リソースの不適切な管理(例: メモリリーク、リソースの二重解放)を招く可能性がある。 自動生成されるメンバ関数では、 複雑なリソース管理の要件を満たせないことがある(「シャローコピー」参照)。

なお、「五の原則」は、「六の原則」と呼ばれることもある。 その場合、この原則が対象とする関数は、 特殊メンバ関数のすべてとなる。

このガイドラインに従って、コピーやムーブを実装する場合、

に従わなけならない。

トリビアル型

トリビアル型とは、

である。その結果、トリビアル型とは、トリビアルに破壊可能な型となる。

「型Tがトリビアルであること」と「以下の行がコンパイルできること」は等価である。

    static_assert(std::is_trivial_v<T>);

下記のコードはその使用例である。

    //  example/term_explanation/trivial_ut.cpp 63

    static_assert(std::is_trivial_v<int>);
    static_assert(std::is_trivial_v<int*>);
    static_assert(std::is_trivial_v<int[1]>);
    static_assert(!std::is_trivial_v<int&>);

    enum class SizeUndefined { su_0, su_1 };

    struct Trivial {      // トリビアルだが標準レイアウトではない
        int&          a;  // リファレンスは標準レイアウトではない
        SizeUndefined b;
    };

    static_assert(!std::is_standard_layout_v<Trivial>);
    static_assert(std::is_trivial_v<Trivial>);
    static_assert(!is_pod_v<Trivial>);

トリビアルに破壊可能な型

「トリビアルに破壊可能な型(Trivially Destructible)」とは、以下の条件を満たす型を指す。

    //  example/term_explanation/trivial_ut.cpp 84

    static_assert(std::is_trivially_destructible_v<int>);
    static_assert(std::is_trivially_destructible_v<int*>);
    static_assert(std::is_trivially_destructible_v<int[1]>);
    static_assert(std::is_trivially_destructible_v<int&>);

    enum class SizeUndefined { su_0, su_1 };

    struct Trivial {  // トリビアルに破壊可能でないため、トリビアル型ではない
        int           a;
        SizeUndefined b;
        ~Trivial() {}
    };

    static_assert(std::is_standard_layout_v<Trivial>);
    static_assert(!std::is_trivial_v<Trivial>);
    static_assert(!std::is_trivially_destructible_v<Trivial>);

標準レイアウト型

「型Tが標準レイアウトであること」と「以下の行がコンパイルできること」は等価である。

    static_assert(std::is_standard_layout_v<T>);

下記のコードはその使用例である。

    //  example/term_explanation/trivial_ut.cpp 42

    static_assert(std::is_standard_layout_v<int>);
    static_assert(std::is_standard_layout_v<int*>);
    static_assert(std::is_standard_layout_v<int[1]>);
    static_assert(!std::is_standard_layout_v<int&>);

    enum class SizeUndefined { su_0, su_1 };

    struct StanderdLayout {  // 標準レイアウトだがトリビアルではない
        StanderdLayout() : a{0}, b{SizeUndefined::su_0} {}
        int           a;
        SizeUndefined b;
    };

    static_assert(std::is_standard_layout_v<StanderdLayout>);
    static_assert(!std::is_trivial_v<StanderdLayout>);
    static_assert(!is_pod_v<StanderdLayout>);

集成体

型Tが集成体であるための条件を以下に示す。

POD

PODとは、 Plain Old Dataの略語であり、 「型TがPODであること」と「以下の行がコンパイルできること」は等価である。

    static_assert(std::is_pod_v<T>);  // is_podはC++20から非推奨

「型がトリビアル型且つ標準レイアウト型であること」と 「型がPODであること」は等価であるため、C++20では、 PODという用語は非推奨となった。 従って、std::is_pod_vは以下のように置き換えられるべきである。

    //  example/term_explanation/trivial_ut.cpp 9

    template <typename T>  // std::is_povはC++20から非推奨
    constexpr bool is_pod_v = std::is_trivial_v<T>&& std::is_standard_layout_v<T>;

下記のコードは置き換えられたstd::is_pod_vの使用例である。

    //  example/term_explanation/trivial_ut.cpp 18

    static_assert(is_pod_v<int>);
    static_assert(is_pod_v<int const>);
    static_assert(is_pod_v<int*>);
    static_assert(is_pod_v<int[3]>);
    static_assert(!is_pod_v<int&>);  // リファレンスはPODではない

    struct Pod {};

    static_assert(is_pod_v<Pod>);
    static_assert(is_pod_v<Pod const>);
    static_assert(is_pod_v<Pod*>);
    static_assert(is_pod_v<Pod[3]>);
    static_assert(!is_pod_v<Pod&>);

    struct NonPod {  // コンストラクタがあるためPODではない
        NonPod();
    };

    static_assert(!is_pod_v<NonPod>);

上記からわかる通り、POD型とは概ね、C言語と互換性のある型を指すと思って良い。

不完全型

不完全型とは、型のサイズや構造が不明な型を指す。 以下のis_completeで示したテンプレート定数で、不完全型か否かを判定できる。

    //  example/term_explanation/incomplete_type_ut.cpp 4

    template <typename T, typename = void>
    struct is_complete : std::false_type {
    };

    template <typename T>  // sizeof(T) が有効であれば、Tは完全型であると判定
    struct is_complete<T, std::void_t<decltype(sizeof(T))>> : std::true_type {
    };

    template <typename T>
    constexpr bool is_complete_v = is_complete<T>::value;
    //  example/term_explanation/incomplete_type_ut.cpp 21

    class A;  // Aの前方宣言
              // これ以降、Aは不完全型となる

    // auto a = sizeof(A);  Aが不完全型であるため、コンパイルエラー
    static_assert(!is_complete_v<A>);
    //  example/term_explanation/incomplete_type_ut.cpp 31

    class A {  // この宣言により、この行以降はAは完全型になる
    public:
        // 何らかの宣言
    };

    auto a = sizeof(A);  // Aが完全型であるため、コンパイル可能
    static_assert(is_complete_v<A>);

完全型

不完全型ではない型を指す。

ポリモーフィックなクラス

ポリモーフィックなクラスとは仮想関数を持つクラスや、 ポリモーフィックなクラスから派生したクラスを指す。 なお、純粋仮想関数を持つクラスは、 仮想クラスと呼ばれれる(「インターフェースクラス」参照)。 ポリモーフィックなクラスと、 非ポリモーフィックなクラスはRTTIとの組み合わせで動作の違いが顕著となる。

非ポリモーフィックなクラスは非静的なメンバ変数が定義された順にメモリ上に配置されたレイアウトを持つ (CPUアーキテクチャに依存したパディング領域が変数間に挿入されることもある)。 このようなクラスはPOD (C++20では、PODという用語は非推奨 となり、トリビアル型標準レイアウト型に用語が分割された)とも呼ばれ、 C言語の構造体のレイアウトと互換性を持つことが一般的である。

ポリモーフィックなクラスは、 仮想関数呼び出しを行う(「オーバーライドとオーバーロードの違い」参照) ためのメモリレイアウトが必要になる。 それを示すために、まずは下記のようにクラスX、Y、Zを定義する。

    //  example/term_explanation/class_layout_ut.cpp 4

    class X {
    public:
        virtual int64_t GetX() { return x_; }
        virtual ~X() {}

    private:
        int64_t x_{1};
    };

    class Y : public X {
    public:
        virtual int64_t GetX() override { return X::GetX() + y_; }
        virtual int64_t GetY() { return y_; }
        virtual ~Y() override {}

    private:
        int64_t y_{2};
    };

    class Z : public Y {
    public:
        virtual int64_t GetX() override { return Y::GetX() + z_; }
        virtual int64_t GetY() override { return Y::GetY() + z_; }
        virtual int64_t GetZ() { return z_; }
        virtual ~Z() override {}

    private:
        int64_t z_{3};
    };

通常のC++コンパイラが作り出すX、Y、Zの概念的なメモリレイアウトは下記のようになる。

下図中のvtbl(virtual table または virtual function table)とは、 仮想関数ポインタを保持するための構造体であり、仮想関数呼び出しを解決するための仕組みである。

各クラスがvtblへのポインタを保持するため、このドキュメントで使用しているg++では、 sizeof(X)は8ではなく16、sizeof(Y)は16ではなく24、sizeof(Z)は24ではなく32となる。

g++の場合、以下のオプションを使用し、クラスのメモリレイアウトをファイルに出力することができる。

    //  example/term_explanation/Makefile 29

    CCFLAGS_ADD:=-fdump-lang-class

X、Y、Zのメモリレイアウトは以下の様に出力される。

    Vtable for X
    X::_ZTV1X: 5 entries
    0     (int (*)(...))0
    8     (int (*)(...))(& _ZTI1X)
    16    (int (*)(...))X::GetX
    24    (int (*)(...))X::~X
    32    (int (*)(...))X::~X

    Class X
       size=16 align=8
       base size=16 base align=8
    X (0x0x7f54bbc23a80) 0
        vptr=((& X::_ZTV1X) + 16)

    Vtable for Y
    Y::_ZTV1Y: 6 entries
    0     (int (*)(...))0
    8     (int (*)(...))(& _ZTI1Y)
    16    (int (*)(...))Y::GetX
    24    (int (*)(...))Y::~Y
    32    (int (*)(...))Y::~Y
    40    (int (*)(...))Y::GetY

    Class Y
       size=24 align=8
       base size=24 base align=8
    Y (0x0x7f54bbc3f000) 0
        vptr=((& Y::_ZTV1Y) + 16)
      X (0x0x7f54bbc23d20) 0
          primary-for Y (0x0x7f54bbc3f000)

    Vtable for Z
    Z::_ZTV1Z: 7 entries
    0     (int (*)(...))0
    8     (int (*)(...))(& _ZTI1Z)
    16    (int (*)(...))Z::GetX
    24    (int (*)(...))Z::~Z
    32    (int (*)(...))Z::~Z
    40    (int (*)(...))Z::GetY
    48    (int (*)(...))Z::GetZ

    Class Z
       size=32 align=8
       base size=32 base align=8
    Z (0x0x7f54bbc3f068) 0
        vptr=((& Z::_ZTV1Z) + 16)
      Y (0x0x7f54bbc3f0d0) 0
          primary-for Z (0x0x7f54bbc3f068)
        X (0x0x7f54bbc43060) 0
            primary-for Y (0x0x7f54bbc3f0d0)

このようなメモリレイアウトは、

    //  example/term_explanation/class_layout_ut.cpp 40

    auto z_ptr = new Z;

のようなオブジェクト生成に密接に関係する。その手順を下記の疑似コードにより示す。

    // ステップ1  メモリアロケーション
    void* ptr = malloc(sizeof(Z));

    // ステップ2  ZオブジェクトのX部分の初期化
    X* x_ptr = (X*)ptr;
    x_ptr->vtbl = &vtbl_for_X       // Xのコンストラクタ呼び出し処理
    x_ptr->x_ = 1;                  // Xのコンストラクタ呼び出し処理

    // ステップ3  ZオブジェクトのY部分の初期化
    Y* y_ptr = (Y*)ptr;
    y_ptr->vtbl = &vtbl_for_Y       // Yのコンストラクタ呼び出し処理
    y_ptr->y_ = 2;                  // Yのコンストラクタ呼び出し処理

    // ステップ4  ZオブジェクトのZ部分の初期化
    Z* z_ptr = (Z*)ptr;
    z_ptr->vtbl = &vtbl_for_Z       // Zのコンストラクタ呼び出し処理
    z_ptr->z_ = 3;                  // Zのコンストラクタ呼び出し処理

オブジェクトの生成がこのように行われるため、Xのコンストラクタ内で仮想関数GetX()を呼び出した場合、 その時のvtblへのポインタはXのvtblを指しており(上記ステップ2)、X::GetX()の呼び出しとなる (Z::GetX()の呼び出しとはならない)。

なお、オブジェクトの解放は生成とは逆の順番で行われる。

オーバーライドとオーバーロードの違い

下記例では、Base::g()がオーバーロードで、Derived::f()がオーバーライドである (Derived::g()はオーバーロードでもオーバーライドでもない(「name-hiding」参照))。

    //  example/term_explanation/override_overload_ut.cpp 5

    class Base {
    public:
        virtual ~Base() = default;
        virtual std::string f() { return "Base::f"; }
        std::string         g() { return "Base::g"; }

        // g()のオーバーロード
        std::string g(int) { return "Base::g(int)"; }
    };

    class Derived : public Base {
    public:
        // Base::fのオーバーライド
        virtual std::string f() override { return "Derived::f"; }

        // Base::gのname-hiding
        std::string g() { return "Derived::g"; }
    };

下記図の通り、

vtblとは仮想関数テーブルとも呼ばれる、仮想関数ポインタを保持するための上記のようなテーブルである (「ポリモーフィックなクラス」参照)。

Base::f()、Derived::f()の呼び出し選択は、オブジェクトの表層の型ではなく、実際の型により決定される。 Base::g()、Derived::g()の呼び出し選択は、オブジェクトの表層の型により決定される。

    //  example/term_explanation/override_overload_ut.cpp 29

    auto  ret   = std::string{};
    auto  b     = Base{};
    auto  d     = Derived{};
    Base& d_ref = d;

    ret = b.f();  // Base::f()呼び出し
    ASSERT_EQ("Base::f", ret);

    ret = d.f();  // Derived::f()呼び出し
    ASSERT_EQ("Derived::f", ret);

    ret = b.g();  // Base::g()呼び出し
    ASSERT_EQ("Base::g", ret);

    ret = d.g();  // Derived::g()呼び出し
    ASSERT_EQ("Derived::g", ret);
    // ret = d.g(int{});   // Derived::gによって、Base::gが隠されるのでコンパイルエラー

    ret = d_ref.f();  // Base::fはDerived::fによってオーバーライドされたので、Derived::f()呼び出し
    ASSERT_EQ("Derived::f", ret);

    ret = d_ref.g();  // d_refの表層型はBaseなので、Base::g()呼び出し
    ASSERT_EQ("Base::g", ret);

    ret = d_ref.g(int{});  // d_refの表層型はBaseなので、Base::g(int)呼び出し
    ASSERT_EQ("Base::g(int)", ret);

上記のメンバ関数呼び出し

    d_ref.f() 

がどのように解釈され、Derived::f()が選択されるかを以下に疑似コードで例示する。

    vtbl = d_ref.vtbl             // d_refの実態はDerivedなのでvtblはDerivedのvtbl

    member_func = vtbl->f         // vtbl->fはDerived::f()のアドレス

    (d_ref.*member_func)(&d_ref)  // member_func()の呼び出し

このようなメカニズムにより仮想関数呼び出しが行われる。

RTTI

RTTI(Run-time Type Information)とは、プログラム実行中のオブジェクトの型を導出するための機能であり、 具体的には下記の3つの要素を指す。

dynamic_cast

dynamic_castは、実行時の型チェックと安全なダウンキャストを行うためのキャスト演算子であるため、 ポリモーフィックなクラスとは密接な関係を持つ。

下記のようなポリモーフィックなクラスに対しては、

    //  example/term_explanation/rtti_ut.cpp 8

    class Polymorphic_Base {  // ポリモーフィックな基底クラス
    public:
        virtual ~Polymorphic_Base() = default;
    };

    class Polymorphic_Derived : public Polymorphic_Base {  // ポリモーフィックな派生クラス
    };

dynamic_castは下記のように振舞う。

    //  example/term_explanation/rtti_ut.cpp 25

    auto b = Polymorphic_Base{};
    auto d = Polymorphic_Derived{};

    Polymorphic_Base& b_ref_d = d;
    Polymorphic_Base& b_ref_b = b;

    // ポインタへのdynamic_cast
    auto* d_ptr = dynamic_cast<Polymorphic_Derived*>(&b_ref_d);
    ASSERT_EQ(d_ptr, &d);

    auto* d_ptr2 = dynamic_cast<Polymorphic_Derived*>(&b_ref_b);
    ASSERT_EQ(d_ptr2, nullptr);  // キャストできない場合、nullptrが返る

    // リファレンスへのdynamic_cast
    auto& d_ref = dynamic_cast<Polymorphic_Derived&>(b_ref_d);
    ASSERT_EQ(&d_ref, &d);

    // キャストできない場合、エクセプションのが発生する
    ASSERT_THROW(dynamic_cast<Polymorphic_Derived&>(b_ref_b), std::bad_cast);

一方で、下記のような非ポリモーフィックなクラスに対しては、

    //  example/term_explanation/rtti_ut.cpp 102

    class NonPolymorphic_Base {  // 非ポリモーフィックな基底クラス
    };

    class NonPolymorphic_Derived : public NonPolymorphic_Base {  // 非ポリモーフィックな派生クラス
    };

dynamic_castは下記のように振舞う。

    //  example/term_explanation/rtti_ut.cpp 115

    auto b = NonPolymorphic_Base{};
    auto d = NonPolymorphic_Derived{};

    NonPolymorphic_Base& b_ref_d = d;
    NonPolymorphic_Base& b_ref_b = b;

    #if 0  // 非ポリモーフィックなクラスへのdynamic_castはill-formedになる
    auto* d_ptr = dynamic_cast<NonPolymorphic_Derived*>(&b_ref_d);
    auto* d_ptr2 = dynamic_cast<NonPolymorphic_Derived*>(&b_ref_b);
    
    //virtual関数を持たないため、リファレンスへのdynamic_castはコンパイルできない
    auto& d_ref = dynamic_cast<NonPolymorphic_Derived&>(b_ref_d);
    ASSERT_THROW(dynamic_cast<NonPolymorphic_Derived&>(b_ref_b), std::bad_cast);
    #endif

typeid

typeidはRTTIオブジェクトの型情報 (std::type_info)を実行時に取得するための演算子である。 dynamic_castとは違い、 typeidのオペランドはポリモーフィックなクラスのインスタンスでなくても良い。 以下の例では基本型に対するtypeidが返すstd::type_infoの振る舞いを表す。

    //  example/term_explanation/rtti_ut.cpp 52

    int   i{};
    long  j{};
    auto& i_ref = i;

    auto const& type_info_i     = typeid(i);
    auto const& type_info_i_ref = typeid(i_ref);

    ASSERT_NE(typeid(i), typeid(j));
    ASSERT_EQ(type_info_i, type_info_i_ref);
    ASSERT_STREQ(type_info_i.name(), "i");  // 実装定義の型名(clang++/g++ではintはi)

下記のようなポリモーフィックなクラスのインスタンスに関して、

    //  example/term_explanation/rtti_ut.cpp 8

class Polymorphic_Base {  // ポリモーフィックな基底クラス
public:
    virtual ~Polymorphic_Base() = default;
};

class Polymorphic_Derived : public Polymorphic_Base {  // ポリモーフィックな派生クラス
};

typeidが返すstd::type_infoオブジェクトは下記のように振舞う。

    //  example/term_explanation/rtti_ut.cpp 65

    auto b = Polymorphic_Base{};
    auto d = Polymorphic_Derived{};

    Polymorphic_Base& b_ref_d = d;
    Polymorphic_Base& b_ref_b = b;

    // ポリモーフィックなクラスインスタンスに対するtypeidが返す
    // std::type_infoオブジェクトが示す型は、オペランドの実際の型である。
    // * b_ref_dの表層の型:Polymorphic_Base
    // * b_ref_dの実際の型:Polymorphic_Derived
    // 下記のアサーションはこのことを表す。
    ASSERT_EQ(typeid(b_ref_d), typeid(d));  // b_ref_dとdの実際の型が同じであることを示す
    ASSERT_EQ(typeid(b_ref_b), typeid(b));  // b_ref_bとbの表層の型が同じであることを示す

一方で、下記のような非ポリモーフィックなクラスに対しては、

    //  example/term_explanation/rtti_ut.cpp 102

    class NonPolymorphic_Base {  // 非ポリモーフィックな基底クラス
    };

    class NonPolymorphic_Derived : public NonPolymorphic_Base {  // 非ポリモーフィックな派生クラス
    };

typeidが返すstd::type_infoオブジェクトは下記のように振舞う。

    //  example/term_explanation/rtti_ut.cpp 139

    auto b = NonPolymorphic_Base{};
    auto d = NonPolymorphic_Derived{};

    NonPolymorphic_Base& b_ref_d = d;
    NonPolymorphic_Base& b_ref_b = b;

    // 非ポリモーフィックなクラスインスタンスに対するtypeidが返す
    // std::type_infoオブジェクトが示す型は、オペランドの表層の型である。
    // * b_ref_dの表層の型:Polymorphic_Base
    // * b_ref_dの実際の型:Polymorphic_Derived
    // 下記のアサーションはこのことを表す。
    ASSERT_EQ(typeid(b_ref_d), typeid(b));  // b_ref_dとdの表層の型が同じであることを示す
    ASSERT_EQ(typeid(b_ref_b), typeid(b));  // b_ref_bとbの表層の型が同じであることを示す

従って、このような場合のtypeidは静的な型(表層の型)に対しての情報を返すため、 コンパイル時にのみ評価され、ランタイム時に評価されない。

ポリモーフィックなクラスのオブジェクトをオペランドとするtypeidの実行は、 そのオペランドの実際のオブジェクトの型を取得することはすでに示した。 このような場合、オペランド式は実行時に評価される。以下のコードはそのことを表している。

    //  example/term_explanation/rtti_ut.cpp 87

    Polymorphic_Base    base;
    Polymorphic_Derived derived;
    Polymorphic_Base*   base_ptr = &derived;

    ASSERT_EQ(typeid(Polymorphic_Derived), typeid(*base_ptr));
    ASSERT_EQ(typeid(Polymorphic_Base), typeid(*(base_ptr = &base)));  // 注意

    // ポリモーフィックなクラスは対しては、typeid内の式が実行される
    ASSERT_EQ(base_ptr, &base);  // base_ptr = &baseが実行される

一方、非ポリモーフィックなクラスのオブジェクトをオペランドとするtypeidのオペランド式は、 コンパイル時に処理されるため、その式は実行されない。以下のコードはそのことを表している。

    //  example/term_explanation/rtti_ut.cpp 161

    NonPolymorphic_Base    base;
    NonPolymorphic_Derived derived;
    NonPolymorphic_Base*   base_ptr = &derived;

    ASSERT_NE(typeid(NonPolymorphic_Derived), typeid(*base_ptr));
    ASSERT_EQ(typeid(NonPolymorphic_Base), typeid(*(base_ptr = &base)));  // 注意

    // 非ポリモーフィックなクラスに対しては、typeid内の式は実行されない
    ASSERT_EQ(base_ptr, &derived);  // base_ptr = &baseは実行されない

std::type_info

type_infoクラスは、typeid演算子によって返される、型の情報が格納された型である。

std::type_infoはコンパイラの実装で定義された型名を含んでいる。 以下のコードで示したようにstd::type_info::name()によりその型名を取り出すことができる。

    //  example/term_explanation/rtti_ut.cpp 179

    auto s = std::string{"str"};
    auto v = std::string_view{"str"};
    auto b = std::byte{0b1001};

    ASSERT_STREQ(typeid(s).name(), "Ss");       // 実装定義の型名
    ASSERT_STREQ(typeid(b).name(), "St4byte");  // 実装定義の型名
    ASSERT_STREQ(typeid(v).name(), "St17basic_string_viewIcSt11char_traitsIcEE");

std::type_info::name()が返すCスタイルの文字列リテラルを、 「人間が認知できる元の型名に戻す関数」を通常のコンパイラは独自に提供する。 このドキュメントのコードのコンパイルに使用しているg++/clang++では、 そのような関数は、abi::__cxa_demangleである。

std::type_info::name()abi::__cxa_demangleを利用して、 オブジェクトの被修飾型名をstd::stringオブジェクトとして取り出す関数とその使用例を以下に示す。

    //  example/term_explanation/rtti_ut.cpp 191

    #include <cxxabi.h>  // g++/clang++実装依存ヘッダ abi::__cxa_demangleの宣言

    #include <memory>
    #include <string>

    template <typename T>
    std::string type2str(T&& obj)
    {
        int status;

        // objに基づく型情報を取得
        auto demangled = std::unique_ptr<char, decltype(&std::free)>{abi::__cxa_demangle(typeid(obj).name(), 0, 0, &status),
                                                                     &std::free};

        return demangled ? demangled.get() : "unknown";
    }
    //  example/term_explanation/rtti_ut.cpp 213

    int   i{};
    auto  s     = std::string{"str"};
    auto& s_ref = s;
    auto  v     = std::string_view{"str"};

    ASSERT_EQ(type2str(i), "int");
    ASSERT_EQ(type2str(s), "std::string");
    ASSERT_EQ(type2str(s_ref), "std::string");
    ASSERT_EQ(type2str(v), "std::basic_string_view<char, std::char_traits<char> >");

    auto b = Polymorphic_Base{};
    auto d = Polymorphic_Derived{};

    Polymorphic_Base& b_ref_d = d;
    Polymorphic_Base& b_ref_b = b;

    ASSERT_EQ(type2str(b_ref_d), "Polymorphic_Derived");  // b_ref_dの実際の型はPolymorphic_Derived
    ASSERT_EQ(type2str(b_ref_b), "Polymorphic_Base");     // b_ref_bの実際の型はPolymorphic_Base

Run-time Type Information

RTTI」を参照せよ。

インターフェースクラス

インターフェースクラスとは、純粋仮想関数のみを持つ抽象クラスのことを指す。 インターフェースクラスは、クラスの実装を提供することなく、 クラスのインターフェースを定義するために使用される。 インターフェースクラスは、クラスの仕様を定義するために使用されるため、 多くの場合、抽象基底クラスとして使用される。

    //  example/term_explanation/interface_class.cpp 8

    class InterfaceClass {  // インターフェースクラス
    public:
        virtual void DoSomething(int32_t) = 0;
        virtual bool IsXxx() const        = 0;
        virtual ~InterfaceClass()         = 0;
    };

    class NotInterfaceClass {  // メンバ変数があるためインターフェースクラスではない
    public:
        NotInterfaceClass();
        virtual void DoSomething(int32_t) = 0;
        virtual bool IsXxx() const        = 0;
        virtual ~NotInterfaceClass()      = 0;

    private:
        int32_t num_;
    };

constインスタンス

constインスタンスは、ランタイムまたはコンパイル時に初期化され、 その後、状態が不変であるインスタンスである。 必ずしも以下に示すようにconstインスタンスがコンパイル時に値が定まっているわけではない。 constexprインスタンスはconstインスタンスである。 C++03までのコンパイラに、 最適化の一環でstatic constインスタンスをconstexprインスタンスと扱うものもあった。

    //  example/term_explanation/const_xxx_ut.cpp 13

    using namespace std;
    auto const str = string{"str"};  // strはプログラムがこの行を通過するときに初期化

    char const* c_str = str.c_str();

    static_assert(!is_const_v<decltype(c_str)>);
    c_str = nullptr;                                                  // c_strは変数としてconstではない
    static_assert(is_const_v<remove_reference_t<decltype(*c_str)>>);  // *cは_strはconst
    static_assert(is_same_v<char const&, decltype(*c_str)>);          // *c_strはconstリファレンス

    char const* const cc_str = c_str;

    static_assert(is_const_v<decltype(cc_str)>);
    // cc_str = nullptr;  // cc_strは変数としてconstであるためコンパイルエラー
    static_assert(is_const_v<remove_reference_t<decltype(*cc_str)>>);  // *cc_strはconst
    static_assert(is_same_v<char const&, decltype(*cc_str)>);          // *cc_strはconstリファレンス

    constexpr int c_int = 1;
    static_assert(is_const_v<decltype(c_int)>);  // c_intはcons

constexpr

constexprはC++11で導入されたキーワードで、 関数や変数をコンパイル時に評価可能にする。 これにより、定数計算がコンパイル時に行われ、 実行時のパフォーマンスが向上し、コンパイル時にエラーを検出できることがある。

constexpr定数

C++11以前で定数を定義する方法は、

の方法があったが、それぞれの方法には下記のような問題がある。

こういった問題を解決できるのがconstexpr定数である。constexpr定数とは下記のような定数を指す。

    //  example/term_explanation/const_xxx_ut.cpp 40

    template <int N>
    struct Templ {
        static constexpr auto value = N;  // valueは定数
    };
    //  example/term_explanation/const_xxx_ut.cpp 49

    constexpr int a = 5;  // aは定数であるためかきのような使い方ができる
    static_assert(a == 5);

    constexpr int b = 5;  // bは定数でないため、下記のような使い方ができない
    // static_assert(b == 5);  // コンパイルエラー

    constexpr double PI{3.14159265358979323846};  // PIはconstexpr

    auto templ = Templ<a>{};  // aはconstexprなのでaの初期化が可能

    static_assert(templ.value == 5);

constexpr定数がif文のオカレンスになる場合、constexpr if文することで、 ill-formedを使用した場合分けが可能になる。

constexpr関数

関数にconstexprをつけて宣言することで定数を定義することができる。 constexpr関数の呼び出し式の値がコンパイル時に確定する場合、 その値はconstexpr定数となるため、関数呼び出しが発生しないため、実行効率が向上する。 一方で、constexpr関数の呼び出し式の値が、コンパイル時に確定しない場合、 通常の関数呼び出しと同じになる。

    //  example/term_explanation/const_xxx_ut.cpp 68

    constexpr int f(int a) noexcept { return a * 3; }  // aがconstexprならばf(a)もconstexpr
    int g(int a) noexcept { return a * 3; }            // aがconstexprであってもg(a)は非constexpr
    //  example/term_explanation/const_xxx_ut.cpp 78

    auto x = int{0};

    constexpr auto a = f(3);     // f(3)はconstexprなのでaの初期化が可能
    // constexpr auto b = f(x);  // xは非constexprなのでbの初期化はコンパイルエラー
    auto const c = f(3);         // cはconstexpr定数と定義とすべき
    // constexpr auto d = g(3);  // g(3)は非constexprなのでdの初期化はコンパイルエラー
    auto const e = g(x);         // eはここで初期化して、この後不変

C++11の規約では、constexpr関数の制約は厳しく、 for/if文や条件分岐のような処理を含むことができなかったため、 下記のコード例で示した通り、条件演算子とリカーシブコールをうことが多かった。

    //  example/term_explanation/const_xxx_ut.cpp 148

    constexpr uint64_t bit_mask(uint32_t max) { return max == 0 ? 0 : (1ULL << (max - 1)) | bit_mask(max - 1); }
    constexpr uint64_t bit_mask_0 = bit_mask(4);  // C++11ではコンパイルエラー
    static_assert(0b1111 == bit_mask_0);

このため、可読性、保守性があったため、C++14で制約が緩和され、 さらにC++17では for/if文などの一般的な制御構文も使えるようになった。

    //  example/term_explanation/const_xxx_ut.cpp 154

    constexpr uint64_t bit_mask_for(uint32_t max)
    {
        uint64_t ret = 0;

        for (auto i = 0u; i < max; ++i) {
            ret |= 1ULL << i;
        }

        return ret;
    }
    constexpr uint64_t bit_mask_1 = bit_mask_for(4);  // C++17からサポート
    static_assert(0b1111 == bit_mask_1);

コア定数式

コア定数式(core constant expression)とは以下の条件を満たす式である。

  1. 以下のいずれかに該当する式であること
  2. 以下のすべてを満たすこと:
  3. その式の評価において:

このドキュメントでは慣用的にconstexpr定数と呼んでいる概念が、コア定数式である。

リテラル型

constexpr導入後のC++11の標準では、下記の条件を満たすクラスは、

constexpr定数もしくはconstexprインスタンスをコンストラクタに渡すことにより、 constexprインスタンスを生成できる。

このようなクラスは慣習的にリテラル型(literal type)と呼ばれる。

以下にリテラル型を例示する。

    //  example/term_explanation/const_xxx_ut.cpp 94

    class Integer {
    public:
        constexpr Integer(int32_t integer) noexcept : integer_{integer} {}
        constexpr operator int() const noexcept { return integer_; }  // constexprメンバ関数はconst
        constexpr int32_t Allways2() const noexcept { return 2; }     // constexprメンバ関数はconst
        static constexpr int32_t Allways3() noexcept { return 3; }    // static関数のconstexpr化

    private:
        int32_t integer_;
    };
    //  example/term_explanation/const_xxx_ut.cpp 112

    constexpr auto i5 = 5;                // i5はconstexprインスタンス
    constexpr auto int_5 = Integer{i5};   // int_5はconstexprインスタンス
    static_assert(int_5 == 5);            // intへの暗黙の型変換

    auto i3  = 3;                         // i3はconstexpr定数ではない
    auto int_3 = Integer{i3};             // int_3はconstexprインスタンスではない
    // static_assert(int_3 == 5);         // int_3がconstexprではないため、コンパイルエラー
    static_assert(int_3.Allways2() == 2); // int_3はconstexprインスタンスではないが、
                                          // int_3.Allways2()はconstexprt定数
    static_assert(int_3.Allways3() == 3); // int_3はconstexprインスタンスではないが、
                                          // int_3.Allways3()はconstexprt定数

constexprインスタンス

constexpr定数を引数にして、リテラル型のconstexprコンストラクタを呼び出せば、 constexprインスタンスを生成できる。このリテラル型を使用して下記のようにユーザー定義リテラル を定義することで、constexprインスタンスをより簡易に使用することができるようになる。

    //  example/term_explanation/const_xxx_ut.cpp 130

    constexpr Integer operator"" _i(unsigned long long int value)  // ユーザ定義リテラルの定義
    {
        return Integer(static_cast<int32_t>(value));
    }
    //  example/term_explanation/const_xxx_ut.cpp 140

    constexpr auto i = 123_i;
    static_assert(i == 123);
    static_assert(std::is_same_v<decltype(i), Integer const>);

consteval

constevalはC++20 から導入されたキーワードであり、 常にコンパイル時に評価されることを保証する関数を定義するために使用される。 このキーワードを使用すると、引数や関数内の処理がコンパイル時に確定できなければ、 コンパイルエラーが発生する。constexprと異なり、ランタイム評価が許されないため、 パフォーマンスの最適化やコンパイル時のエラー検出に特化した関数を作成する際に便利である。

    //  example/term_explanation/const_xxx_ut.cpp 184

    #if __cplusplus >= 202002L  // c++20
    consteval uint64_t bit_mask(uint32_t max)  // コンパイル時、評価ができなければエラー

    #else // C++17
    constexpr uint64_t bit_mask(uint32_t max)  // コンパイル時、評価されるとは限らない
    #endif
    {
        if (max == 0) {
            return 0;
        }
        else {
            return (1ULL << (max - 1)) | bit_mask(max - 1);
        }
    }
    //  example/term_explanation/const_xxx_ut.cpp 206

    static_assert(0b1111'1111 == bit_mask(8));

    // auto i = 8UL;         // bit_maskがconstevalであるため、コンパイルエラー
    constexpr auto i = 8UL;  // iがconstexpであるためbit_maskががコンパイル時評価されるため、
    auto bm = bit_mask(i);   // bit_mask(i)の呼び出しは効率的になる
                             // bmをconsexprにするとさらに効率的になる

    ASSERT_EQ(0b1111'1111, bm);

constexprラムダ

constexprラムダはC++17から導入された機能であり、以下の条件を満たしたラムダ式である。

    //  example/term_explanation/const_xxx_ut.cpp 223

    constexpr auto factorial = [](int n) {  // constexpr ラムダの定義
        int result = 1;
        for (int i = 2; i <= n; ++i) {
            result *= i;
        }
        return result;
    };

    constexpr int fact_5 = factorial(5);  // コンパイル時に計算される
    static_assert(fact_5 == 120);
    //  example/term_explanation/const_xxx_ut.cpp 240

    constexpr auto factorial = [](auto self, int n) -> int {  // リカーシブconstexprラムダ
        return (n <= 1) ? 1 : n * self(self, n - 1);
    };

    constexpr int fact_5 = factorial(factorial, 5);  // コンパイル時の評価
    static_assert(fact_5 == 120);

オブジェクトと生成

リスト初期化

リスト初期化とは、C++11で導入された{}を使ったオブジェクトの初期化構文を指す。 以下にコード例を示す。

    //  example/term_explanation/uniform_initialization_ut.cpp 12

    struct X {
        X(int) {}
    };

    X x0(0);   // 通常従来のコンストラクタ呼び出し
    X x1 = 0;  // 暗黙の型変換を使用した従来のコンストラクタ呼び出し

    X x2{0};     // リスト初期化
    X x3 = {0};  // 暗黙の型変換を使用したリスト初期化

    struct Y {
        Y(int, double, std::string) {}
    };

    auto lamda = [](int, double, std::string) -> Y {
        return {1, 3.14, "hello"};  // 暗黙の型変換を使用したリスト初期化でのYの生成
    };

変数による一様初期化が縮小型変換を起こす場合や、 リテラルによる一様初期化がその値を変更する場合、コンパイルエラーとなるため、 この機能を積極的に使用することで、縮小型変換による初期化のバグを未然に防ぐことができる。

    //  example/term_explanation/uniform_initialization_ut.cpp 34

    int i{0};  // リスト初期化

    bool b0 = 7;  // 縮小型変換のため、b0の値はtrue(通常は1)となる
    ASSERT_EQ(b0, 1);

    // bool b1{7};  // 縮小型変換のため、コンパイルエラー
    // bool b2{i};  // 縮小型変換のため、コンパイルエラー

    uint8_t u8_0 = 256;  // 縮小型変換のためu8_0は0となる
    ASSERT_EQ(u8_0, 0);

    // uint8_t u8_1{256};  // 縮小型変換のため、コンパイルエラー
    // uint8_t u8_2{i};    // 縮小型変換のため、コンパイルエラー

    uint8_t array0[3]{1, 2, 255};  // リスト初期化
    // uint8_t array1[3] = {1, 2, 256};  // 縮小型変換のため、コンパイルエラー
    // uint8_t array2[3]{1, 2, 256};     // 縮小型変換のため、コンパイルエラー
    // uint8_t array2[3]{1, 2, i};       // 縮小型変換のため、コンパイルエラー

    int i0 = 1.0;  // 縮小型変換のため、i0の値は1
    ASSERT_EQ(i0, 1);

    // int i1{1.0};  // 縮小型変換のため、コンパイルエラー

    double d{1};  // 縮小型変換は起こらないのでコンパイル可能
    // int i2{d};  // 縮小型変換のため、コンパイルエラー

一様初期化

一様初期化(Uniform Initialization)は 、 リスト初期化による初期化方法がC++における初期化を統一的に扱えるように設計された概念を指さす。

初期化子リストコンストラクタ

初期化子リストコンストラクタ(リスト初期化用のコンストラクタ)とは、 {}によるリスト初期化をサポートするためのコンストラクタである。 下記コードでは、 E::E(std::initializer_list<uint32_t>)が初期化子リストコンストラクタである。

    //  example/term_explanation/constructor_ut.cpp 6

    class E {
    public:
        E() : str_{"default constructor"} {}

        // 初期化子リストコンストラクタ
        explicit E(std::initializer_list<uint32_t>) : str_{"initializer list constructor"} {}

        explicit E(uint32_t, uint32_t) : str_{"uint32_t uint32_t constructor"} {}

        std::string const& GetString() const { return str_; }

    private:
        std::string const str_;
    };

    TEST(Constructor, initializer_list_constructor)
    {
        E const e0;
        ASSERT_EQ("default constructor", e0.GetString());

        E const e1{};
        ASSERT_EQ("default constructor", e1.GetString());

        E const e2{3, 4};  // E::E(uint32_t, uint32_t)の呼び出しと区別が困難
        ASSERT_EQ("initializer list constructor", e2.GetString());

        E const e3(3, 4);  // E::E(std::initializer_list<uint32_t>)の呼び出しと区別が困難
        ASSERT_EQ("uint32_t uint32_t constructor", e3.GetString());
    }

デフォルトコンストラクタと初期化子リストコンストラクタが、 それぞれに定義されているクラスの初期化時に空の初期化子リストが渡された場合、 デフォルトコンストラクタが呼び出される。

初期化子リストコンストラクタと、 「その初期化子リストの要素型と同じ型の仮引数のみを受け取るコンストラクタ (上記コードのE::E(uint32_t, uint32_t))」 の両方を持つクラスの初期化時にどちらでも呼び出せる初期化子リストが渡された場合({}を使った呼び出し)、 初期化子コンストラクタが呼び出される。

継承コンストラクタ

継承コンストラクタとは、基底クラスで定義したコンストラクタ群を、 派生クラスのインターフェースとしても使用できるようにするための機能である。 下記コードのように、継承コンストラクタは派生クラス内でusingを用いて宣言される。

    //  example/term_explanation/constructor_ut.cpp 40

    class Base {
    public:
        explicit Base(int32_t b) noexcept : b_{b} {}
        virtual ~Base() = default;
        // ...
    };

    class Derived : public Base {
    public:
        using Base::Base;  // 継承コンストラクタ
    #if 0
        Derived(int32_t b) : Base{b} {}  // オールドスタイル
    #endif
    };

    void f() noexcept
    {
        Derived d{1};  // Derived::Derived(int32_t)が使える
        // ...
    }

委譲コンストラクタ

委譲コンストラクタとは、コンストラクタから同じクラスの他のコンストラクタに処理を委譲する機能である。 以下のコード中では、委譲コンストラクタを使い、 A::A(uint32_t)の処理をA::A(std::string const&)へ委譲している。

    //  example/term_explanation/constructor_ut.cpp 72

    class A {
    public:
        explicit A(std::string str) : str_{std::move(str)}
        {
            // ...
        }

        explicit A(uint32_t num) : A{std::to_string(num)}  // 委譲コンストラクタ
        {
        }

    private:
        std::string str_;
    };

非静的なメンバ変数の初期化

非静的なメンバ変数の初期化には下記の3つの方法がある。

同一変数に対して、 「NSDMI」と「初期化子リストでの初期化」 が行われた場合、その変数に対するNSDMIは行われない。

NSDMI

NSDMIとは、non-static data member initializerの略語であり、 下記のような非静的なメンバ変数の初期化子を指す。

    //  example/term_explanation/nsdmi.cpp 11

    class A {
    public:
        A() : a_{1}  // NSDMIではなく、非静的なメンバ初期化子による初期化
        {
        }

    private:
        int32_t     a_;
        int32_t     b_ = 0;        // NSDMI
        std::string str_{"init"};  // NSDMI
    };

初期化子リストでの初期化

「非静的メンバ変数をコンストラクタの本体よりも前に初期化する」言語機能である。 メンバ変数は宣言された順序で初期化されるため、 初期化子リストでの順序は、実際の初期化の順序とは関係がない。

この機能を使うことで、メンバ変数の初期化処理が簡素に記述できる。 constメンバ変数は、初期化子リストでの初期化かNSDMIでしか初期化できない。

    //  example/term_explanation/nsdmi.cpp 27

    class A {
    public:
        A(int a, int b) : v_{a, b, 3}, a_{a}  // 非静的なメンバ初期化子による初期化
        //                 ^^^^^^^^^^^^^ メンバ変数の初期化は
        //                                  - 宣言順に行われる。
        //                                  - 初期化リストの順番と、初期化の順番には関係がない。
        {
        }

    private:
        int              a_;
        std::vector<int> v_;
    };

コンストラクタ内での非静的なメンバ変数の初期値の代入

この方法は単なる代入でありメンバ変数の初期化ではない。

NSDMI初期化子リストでの初期化で初期化できない変数を未初期化でない状態にするための唯一の方法である。

    //  example/term_explanation/nsdmi.cpp 45

    class A {
    public:
        A(int a, int b)
        {
            a_ = b;                     // 非静的なメンバのコンストラクタでの代入
            v_ = std::vector{a, b, 3};  // 非静的なメンバのコンストラクタでの代入
        }

    private:
        int              a_;
        std::vector<int> v_;
    };

オブジェクトの所有権

オブジェクトxがオブジェクトaの解放責務を持つ場合、 xはaの所有権を持つ(もしくは、所有する) という。

定義から明らかな通り、ダイナミックに生成されたaをxが所有する場合、 xはa(へのポインタ)をdeleteする責務を持つ。

xがaを所有し、且つxがaを他のオブジェクトと共有しない場合、「xはaを排他所有する」という。

オブジェクト群x0、x1、…、xNがaを所有する場合、 「x0、x1、…、xNはaを共有所有する」という。

x0、x1、…、xNがaを共有所有する場合、x0、x1、…、xN全体で、a(へのポインタ)をdeleteする責務を持つ。

下記で示したような状況では、 ダイナミックに生成されたオブジェクトの所有権の所在をコードから直ちに読み取ることは困難であり、 その解放責務も曖昧となる。

    //  example/term_explanation/ambiguous_ownership_ut.cpp 11

    class A {
        // 何らかの宣言
    };

    class X {
    public:
        explicit X(A* a) : a_{a} {}
        A* GetA() { return a_; }

    private:
        A* a_;
    };

    auto* a = new A;
    auto  x = X{a};
    // aがxに排他所有されているのか否かの判断は難しい

    auto x0 = X{new A};
    auto x1 = X{x0.GetA()};
    // x0生成時にnewされたオブジェクトがx0とx1に共有所有されているのか否かの判断は難しい

こういった問題に対処するためのプログラミングパターンを以下の 「オブジェクトの排他所有」と「オブジェクトの共有所有」で解説する。

オブジェクトの排他所有

オブジェクトの排他所有や、それを容易に実現するための std::unique_ptr の仕様を説明するために、下記のようにクラスA、Xを定義する。

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 7

    class A final {
    public:
        explicit A(int32_t n) noexcept : num_{n} { last_constructed_num_ = num_; }
        ~A() { last_destructed_num_ = num_; }

        int32_t GetNum() const noexcept { return num_; }

        static int32_t LastConstructedNum() noexcept { return last_constructed_num_; }
        static int32_t LastDestructedNum() noexcept { return last_destructed_num_; }

    private:
        int32_t const  num_;
        static int32_t last_constructed_num_;
        static int32_t last_destructed_num_;
    };

    int32_t A::last_constructed_num_ = -1;
    int32_t A::last_destructed_num_  = -1;

    class X final {
    public:
        // Xオブジェクトの生成と、ptrからptr_へ所有権の移動
        explicit X(std::unique_ptr<A>&& ptr) : ptr_{std::move(ptr)} {}

        // ptrからptr_へ所有権の移動
        void Move(std::unique_ptr<A>&& ptr) noexcept { ptr_ = std::move(ptr); }

        // ptr_から外部への所有権の移動
        std::unique_ptr<A> Release() noexcept { return std::move(ptr_); }

        A const* GetA() const noexcept { return ptr_ ? ptr_.get() : nullptr; }

    private:
        std::unique_ptr<A> ptr_{};
    };

下記に示した上記クラスの単体テストにより、 オブジェクトの所有権やその移動、 std::unique_ptr、std::move()、rvalueの関係を解説する。

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 48

    // ステップ0
    // まだ、クラスAオブジェクトは生成されていないため、
    // A::LastConstructedNum()、A::LastDestructedNum()は初期値である-1である。
    ASSERT_EQ(-1, A::LastConstructedNum());     // まだ、A::A()は呼ばれてない
    ASSERT_EQ(-1, A::LastDestructedNum());      // まだ、A::~A()は呼ばれてない
    //  example/term_explanation/unique_ptr_ownership_ut.cpp 57

    // ステップ1
    // a0、a1がそれぞれ初期化される。
    auto a0 = std::make_unique<A>(0);           // a0はA{0}を所有
    auto a1 = std::make_unique<A>(1);           // a1はA{1}を所有

    ASSERT_EQ(1,  A::LastConstructedNum());     // A{1}は生成された
    ASSERT_EQ(-1, A::LastDestructedNum());      // まだ、A::~A()は呼ばれてない

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 67

    // ステップ2
    // xが生成され、オブジェクトA{0}の所有がa0からxへ移動する。
    ASSERT_EQ(0, a0->GetNum());                 // a0はA{0}を所有
    auto x = X{std::move(a0)};                  // xの生成と、a0からxへA{0}の所有権の移動
    ASSERT_FALSE(a0);                           // a0は何も所有していない

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 75

    // ステップ3
    // オブジェクトA{1}の所有がa1からxへ移動する。
    // xは以前保持していたA{0}オブジェクトへのポインタをdeleteするため
    // (std::unique_ptrによる自動delete)、A::LastDestructedNum()の値が0になる。
    ASSERT_EQ(1, a1->GetNum());                 // a1はA{1}を所有
    x.Move(std::move(a1));                      // xによるA{0}の解放
                                                // a1からxへA{1}の所有権の移動
                                                // Moveの処理は ptr_ = std::move(a1)
    ASSERT_EQ(0, A::LastDestructedNum());       // A{0}は解放された
    ASSERT_FALSE(a1);                           // a1は何も所有していない
    ASSERT_EQ(1, x.GetA()->GetNum());           // xはA{1}を所有

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 89

    // ステップ4
    // x.ptr_はstd::unique_ptr<A>であるため、ステップ3の状態では、
    // x.ptr_はA{1}オブジェクトのポインタを保持しているが、
    // x.Release()はそれをrvalueに変換し戻り値にする。
    // その戻り値をa2で受け取るため、A{1}の所有はxからa2に移動する。
    std::unique_ptr<A> a2{x.Release()};         // xからa2へA{1}の所有権の移動
    ASSERT_EQ(nullptr, x.GetA());               // xは何も所有していない
    ASSERT_EQ(1, a2->GetNum());                 // a2はA{1}を所有

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 100

    // ステップ5
    // a2をstd::move()によりrvalueに変換し、ブロック内のa3に渡すことで、
    // A{1}の所有はa2からa3に移動する。
    {
        std::unique_ptr<A> a3{std::move(a2)};
        ASSERT_FALSE(a2);                       // a2は何も所有していない
        ASSERT_EQ(1, a3->GetNum());             // a3はA{1}を所有

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 110

        // ステップ6
        // このブロックが終了することで、std::unique_ptrであるa3のデストラクタが呼び出される。
        // これはA{1}オブジェクトへのポインタをdeleteする。
    }                                      // a3によるA{1}の解放
    ASSERT_EQ(1, A::LastDestructedNum());  // A{1}が解放されたことの確認

また、以下に見るようにstd::unique_ptrはcopy生成やcopy代入を許可しない。

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 124

    auto a0 = std::make_unique<A>(0);

    // auto a1 = a0;                            // 下記のようなメッセージでコンパイルエラー
    //      unique_ptr_ownership_ut.cpp:125:15: error: use of deleted function ‘std::unique_ptr ...

    auto a1 = std::move(a0);                    // すでに示したようにmove生成は可能
    
    auto a2 = std::unique_ptr<A>{};

    // a2 = a1;                                 // 下記のようなメッセージでコンパイルエラー
    //      unique_ptr_ownership_ut.cpp:131:10: error: use of deleted function ‘std::unique_ptr ...

    a2 = std::move(a1);                         // すでに示したようにmove代入は可能

    //
    auto x0 = X{std::make_unique<A>(0)};

    // auto x1 = x0;                            // Xはstd::unique_ptrをメンバとするため、
                                                // デフォルトのcopyコンストラクタによる生成は
                                                // コンパイルエラー
    auto x1 = std::move(x0);                    // デフォルトのmove生成は可能

    auto x2 = X{std::make_unique<A>(0)};

    // x2 = x1;                                 // Xはstd::unique_ptrをメンバとするため、
                                                // デフォルトのcopy代入子の呼び出しは
                                                // コンパイルエラー
    x2 = std::move(x1);                         // デフォルトのmove代入は可能

以上で示したstd::unique_ptrの仕様の要点をまとめると、以下のようになる。

    //  example/term_explanation/unique_ptr_ownership_ut.cpp 162

    // 以下のようなコードを書いてはならない

    auto a0 = std::make_unique<A>(0);
    auto a1 = std::unique_ptr<A>{a0.get()};  // a1もa0が保持するオブジェクトを保持するが、
                                             // 保持されたオブジェクトは二重解放される

    auto a_ptr = new A{0};

    auto a2 = std::unique_ptr<A>{a_ptr};
    auto a3 = std::unique_ptr<A>{a_ptr};  // a3もa2が保持するオブジェクトを保持するが、
                                          // 保持されたオブジェクトは二重解放される

こういった機能によりstd::unique_ptrはオブジェクトの排他所有を実現している。

オブジェクトの共有所有

オブジェクトの共有所有や、それを容易に実現するための std::shared_ptr の仕様を説明するために、下記のようにクラスA、Xを定義する。

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 7

    class A final {
    public:
        explicit A(int32_t n) noexcept : num_{n} { last_constructed_num_ = num_; }
        ~A() { last_destructed_num_ = num_; }

        int32_t GetNum() const noexcept { return num_; }

        static int32_t LastConstructedNum() noexcept { return last_constructed_num_; }
        static int32_t LastDestructedNum() noexcept { return last_destructed_num_; }

    private:
        int32_t const  num_;
        static int32_t last_constructed_num_;
        static int32_t last_destructed_num_;
    };

    int32_t A::last_constructed_num_ = -1;
    int32_t A::last_destructed_num_  = -1;

    class X final {
    public:
        // Xオブジェクトの生成と、ptrからptr_へ所有権の移動もしくは共有
        explicit X(std::shared_ptr<A> ptr) : ptr_{std::move(ptr)} {}

        // ptrからptr_へ所有権の移動
        void Move(std::shared_ptr<A>&& ptr) noexcept { ptr_ = std::move(ptr); }

        int32_t UseCount() const noexcept { return ptr_.use_count(); }

        A const* GetA() const noexcept { return ptr_ ? ptr_.get() : nullptr; }

    private:
        std::shared_ptr<A> ptr_{};
    };

下記に示した上記クラスの単体テストにより、 オブジェクトの所有権やその移動、共有、 std::shared_ptr、std::move()、rvalueの関係を解説する。

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 47

    // ステップ0
    // まだ、クラスAオブジェクトは生成されていないため、
    // A::LastConstructedNum()、A::LastDestructedNum()は初期値である-1である。
    ASSERT_EQ(-1, A::LastConstructedNum());     // まだ、A::A()は呼ばれてない
    ASSERT_EQ(-1, A::LastDestructedNum());      // まだ、A::~A()は呼ばれてない
    //  example/term_explanation/shared_ptr_ownership_ut.cpp 56

    // ステップ1
    // a0、a1がそれぞれ初期化される。
    auto a0 = std::make_shared<A>(0);           // a0はA{0}を所有
    auto a1 = std::make_shared<A>(1);           // a1はA{1}を所有
    ASSERT_EQ(1, a0.use_count());               // A{0}の共有所有カウント数は1
    ASSERT_EQ(1, a1.use_count());               // A{1}の共有所有カウント数は1

    ASSERT_EQ(1,  A::LastConstructedNum());     // A{1}は生成された
    ASSERT_EQ(-1, A::LastDestructedNum());      // まだ、A::~A()は呼ばれてない

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 68

    // ステップ2
    // x0が生成され、オブジェクトA{0}がa0とx0に共同所有される。
    ASSERT_EQ(0, a0->GetNum());                 // a0はA{0}を所有
    ASSERT_EQ(1, a0.use_count());               // A{0}の共有所有カウントは1
    auto x0 = X{a0};                            // x0の生成と、a0とx0によるA{0}の共有所有
    ASSERT_EQ(2, a0.use_count());               // A{0}の共有所有カウント数は2
    ASSERT_EQ(2, x0.UseCount());
    ASSERT_EQ(x0.GetA(), a0.get());

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 79

    // ステップ3
    // x1が生成され、オブジェクトA{0}の所有がa0からx1へ移動する。
    auto x1 = X{std::move(a0)};                 // x1の生成と、a0からx1へA{0}の所有権の移動
    ASSERT_EQ(x1.GetA(), x1.GetA());            // x0、x1がA{0}を共有所有
    ASSERT_EQ(2, x0.UseCount());                // A{0}の共有所有カウント数は2
    ASSERT_EQ(2, x1.UseCount());
    ASSERT_FALSE(a0);                           // a0は何も所有していない

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 89

    // ステップ4
    // オブジェクトA{1}の所有がa1からx1へ移動する。
    // この時、x1::ptr_は下記のような手順で以前保持していたA{0}オブジェクトへの所有を放棄する。
    //  1. x1::ptr_の共有所有カウント(ptr_.use_count()の戻り値)をデクリメント
    //  2. 共有所有カウントが0ならば、ptr_で保持しているオブジェクト(この場合、A{0})をdelete
    //  3. x1::ptr_の管理対象をに新規オブジェクト(この場合、A{1})に変更
    //
    // ここでは、x0::ptr_がA{0}を所有しているため、共有所有カウントは1であり、
    // 従って、A{0}はdeleteされず、A::LastDestructedNum()の値は-1のまま。
    ASSERT_EQ(1, a1->GetNum());                 // a1はA{1}を所有
    ASSERT_EQ(0, x1.GetA()->GetNum());          // x1はA{0}を所有
    ASSERT_EQ(2, x1.UseCount());                // A{0}の共有所有カウント数は2
    x1.Move(std::move(a1));                     // x1はA{0}の代わりに、A{1}を所有
                                                // a1からx1へA{1}の所有権の移動
    ASSERT_EQ(-1, A::LastDestructedNum());      // x0がA{0}を所有するため、A{0}は未解放
    ASSERT_FALSE(a1);                           // a1は何も所有していない
    ASSERT_EQ(1, x1.GetA()->GetNum());          // x1はA{1}を所有
    ASSERT_EQ(1, x1.UseCount());                // A{1}の共有所有カウント数は1

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 110

    // ステップ5
    // 現時点でx1はA{1}オブジェクトを保持している。
    // x1::Moveに空のstd::shared_ptrを渡すことにより、A{1}を解放する。
    x1.Move(std::shared_ptr<A>{});              // x1に空のstd::shared_ptr<A>を代入することで、
                                                // A{1}を解放
    ASSERT_EQ(nullptr, x1.GetA());              // x1は何も保持していない
    ASSERT_EQ(1, A::LastDestructedNum());       // A{1}が解放された

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 120

    // ステップ6
    // 現時点でx0はA{0}オブジェクトを保持している。
    //
    // ここでは、x0からx2、x3をそれぞれcopy、move生成し、
    // この次のステップ7では、x2、x3がスコープアウトすることでA{0}を解放する。
    {
        ASSERT_EQ(0, x0.GetA()->GetNum());      // x0はA{0}を所有
        ASSERT_EQ(1, x0.UseCount());            // A{0}の共有所有カウント数は1
        auto x2 = x0;                           // x0からx2をcopy生成
        ASSERT_EQ(x0.GetA(), x2.GetA());
        ASSERT_EQ(2, x0.UseCount());            // A{0}の共有所有カウント数は2

        auto x3 = std::move(x0);                // x0からx2をmove生成、x0はA{0}の所有を放棄
        ASSERT_EQ(nullptr, x0.GetA());
        ASSERT_EQ(0, x2.GetA()->GetNum());      // x2はA{0}を保有
        ASSERT_EQ(x2.GetA(), x3.GetA());        // x2、x3はA{0}を共有保有
        ASSERT_EQ(2, x2.UseCount());            // A{1}の共有所有カウント数は2

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 142

        // ステップ7
        // このブロックが終了することで、x2、x3はスコープアウトする。
        // デストラクタ呼び出しの順序はコンストラクタ呼び出しの逆になるため、
        // 最初にx3::~X()が呼び出され、この延長でx3::ptr_のデストラクタが呼び出される。
        // これによりA{0}のの共有所有カウントは1になる。
        // 次にx2::~X()が呼び出され、この延長でx2::ptr_のデストラクタが呼び出される。
        // これによりA{0}のの共有所有カウントは0になり、A{0}はdeleteされる。
        // 
    }   // x2、x3のスコープアウト
    ASSERT_EQ(0, A::LastDestructedNum());  // A{0}が解放された
    

以上で示したstd::shared_ptrの仕様の要点をまとめると、以下のようになる。

    //  example/term_explanation/shared_ptr_ownership_ut.cpp 162

    // 以下のようなコードを書いてはならない

    auto a0 = std::make_shared<A>(0);
    auto a1 = std::shared_ptr<A>{a0.get()};  // a1もa0が保持するオブジェクトを保持するが、
                                             // 保持されたオブジェクトは二重解放される

    auto a_ptr = new A{0};

    auto a2 = std::shared_ptr<A>{a_ptr};
    auto a3 = std::shared_ptr<A>{a_ptr};  // a3もa2が保持するオブジェクトを保持するが、
                                          // 保持されたオブジェクトは二重解放される

こういった機能によりstd::shared_ptrはオブジェクトの共有所有を実現している。

オブジェクトの循環所有

std::shared_ptrの使い方を誤ると、 以下のコード例が示すようにメモリーリークが発生する。

なお、この節の題名である「オブジェクトの循環所有」という用語は、 この前後の節がダイナミックに確保されたオブジェクトの所有の概念についての解説しているため、 この用語を選択したが、文脈によっては、「オブジェクトの循環参照」といった方がふさわしい場合もある。


まずは、メモリリークが発生しないstd::shared_ptrの正しい使用例を示す。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 8

    class Y;
    class X final {
    public:
        explicit X() noexcept { ++constructed_counter; }
        ~X() { --constructed_counter; }

        static uint32_t constructed_counter;

    private:
        std::shared_ptr<Y> y_{};  // 初期化状態では、y_はオブジェクトの所有しない(use_count()==0)
    };
    uint32_t X::constructed_counter;

    class Y final {
    public:
        explicit Y() noexcept { ++constructed_counter; }
        ~Y() { --constructed_counter; }

        static uint32_t constructed_counter;

    private:
        std::shared_ptr<X> x_{};  // 初期化状態では、x_はオブジェクトの所有しない(use_count()==0)
    };
    uint32_t Y::constructed_counter;

上記のクラスの使用例を示す。下記をステップ1とする。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 39

    {  // ステップ1
        ASSERT_EQ(X::constructed_counter, 0);
        ASSERT_EQ(Y::constructed_counter, 0);

        auto x0 = std::make_shared<X>();
        auto y0 = std::make_shared<Y>();

        ASSERT_EQ(x0.use_count(), 1);

        ASSERT_EQ(y0.use_count(), 1);

        ASSERT_EQ(X::constructed_counter, 1);
        ASSERT_EQ(Y::constructed_counter, 1);

上記の続きを以下に示し、ステップ2とする。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 55
        // ステップ2

        auto x1 = x0;  // x0が保有するオブジェクトをx1にも所有させる
        auto y1 = y0;  // y0が保有するオブジェクトをy1にも所有させる

        ASSERT_EQ(X::constructed_counter, 1);  // 新しいオブジェクトが生成されるわけではない
        ASSERT_EQ(Y::constructed_counter, 1);  // 新しいオブジェクトが生成されるわけではない

        ASSERT_EQ(x1.use_count(), 2);  // コピーしたため、参照カウントが増えた
        ASSERT_EQ(y1.use_count(), 2);  // コピーしたため、参照カウントが増えた

上記の続きを以下に示し、ステップ3とする。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 67
        // ステップ3

        auto x2 = std::move(x1);  // x1が保持する所有権をx2に移動(この後x1はオブジェクトを所有しない)
        auto y2 = std::move(y1);  // y1が保持する所有権をy2に移動(この後y1はオブジェクトを所有しない)

        ASSERT_EQ(x1.use_count(), 0);  // ムーブしたため、参照カウントが0に
        ASSERT_EQ(y1.use_count(), 0);  // ムーブしたため、参照カウントが0に

        ASSERT_EQ(x0.use_count(), 2);  // x0からムーブしていないので参照カウントは不変
        ASSERT_EQ(y0.use_count(), 2);  // y0からムーブしていないので参照カウントは不変

上記の続きを以下に示し、ステップ4とする。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 79

    }  // この次の行で、x0、x2、y0、y2はスコープアウトし、X、Yオブジェクトは解放される

    ASSERT_EQ(X::constructed_counter, 0);  // Xオブジェクトの解放の確認
    ASSERT_EQ(Y::constructed_counter, 0);  // Yオブジェクトの解放の確認

このような動作により、std::make_shared<>で生成されたX、Yオブジェクトは解放される。


次はメモリリークが発生するstd::shared_ptrの誤用を示す。まずはクラスの定義から。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 91

    class Y;
    class X final {
    public:
        explicit X() noexcept { ++constructed_counter; }
        ~X() { --constructed_counter; }

        void Register(std::shared_ptr<Y> y) { y_ = y; }

        std::shared_ptr<Y> const& ref_y() const noexcept { return y_; }

        // 自身の状態を返す ("X alone" または "X with Y")
        std::string WhoYouAre() const;

        // y_が保持するオブジェクトの状態を返す ("None" またはY::WhoYouAre()に委譲)
        std::string WhoIsWith() const;

        static uint32_t constructed_counter;

    private:
        std::shared_ptr<Y> y_{};  // 初期化状態では、y_はオブジェクトを所有しない(use_count()==0)
    };

    class Y final {
    public:
        explicit Y() noexcept { ++constructed_counter; }
        ~Y() { --constructed_counter; }

        void Register(std::shared_ptr<X> x) { x_ = x; }

        std::shared_ptr<X> const& ref_x() const noexcept { return x_; }

        // 自身の状態を返す ("Y alone" または "Y with X")
        std::string WhoYouAre() const;

        // x_が保持するオブジェクトの状態を返す ("None" またはY::WhoYouAre()に委譲)
        std::string WhoIsWith() const;

        static uint32_t constructed_counter;

    private:
        std::shared_ptr<X> x_{};  // 初期化状態では、x_はオブジェクトを所有しない(use_count()==0)
    };

    // Xのメンバ定義
    std::string X::WhoYouAre() const { return y_ ? "X with Y" : "X alone"; }
    std::string X::WhoIsWith() const { return y_ ? y_->WhoYouAre() : std::string{"None"}; }
    uint32_t    X::constructed_counter;

    // Yのメンバ定義
    std::string Y::WhoYouAre() const { return x_ ? "Y with X" : "Y alone"; }
    std::string Y::WhoIsWith() const { return x_ ? x_->WhoYouAre() : std::string{"None"}; }
    uint32_t    Y::constructed_counter;

上記のクラスの動作を以下に示したコードで示す。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 151

    {
        ASSERT_EQ(X::constructed_counter, 0);
        ASSERT_EQ(Y::constructed_counter, 0);

        auto x0 = std::make_shared<X>();       // Xオブジェクトを持つshared_ptrの生成
        ASSERT_EQ(X::constructed_counter, 1);  // Xオブジェクトは1つ生成された

        ASSERT_EQ(x0.use_count(), 1);
        ASSERT_EQ(x0->WhoIsWith(), "None");     // x0.y_は何も保持していないので、"None"
        ASSERT_EQ(x0->ref_y().use_count(), 0);  // X::y_は何も持っていない

x0のライフタイムに差を作るために新しいスコープを導入し、そのスコープ内で、y0を生成し、 X::RegisterY::Registerを用いて、循環を作ってしまう例(メモリーリークを起こすバグ)を示す。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 165

        {
            auto y0 = std::make_shared<Y>();

            ASSERT_EQ(Y::constructed_counter, 1);   // Yオブジェクトは1つ生成された
            ASSERT_EQ(y0.use_count(), 1);
            ASSERT_EQ(y0->ref_x().use_count(), 0);  // y0.x_は何も持っていない
            ASSERT_EQ(y0->WhoYouAre(), "Y alone");  // y0.x_は何も持っていないので、"Y alone"

            x0->Register(y0);                       // これによりx0.y_はy0と同じYオブジェクトを持つ
            ASSERT_EQ(x0->WhoIsWith(), "Y alone");  // x0が持つYオブジェクトはまだXを持っていない状態

            y0->Register(x0);                       // これによりy0.y_はx0と同じオブジェクトを持つ
            // 上記で生成されたXオブジェクト、Yオブジェクトは、x0->Register(y0), y0->Register(x0)により
            // 相互に参照しあう状態になる
            ASSERT_EQ(X::constructed_counter, 1);   // 新しいオブジェクトが生成されるわけではない
            ASSERT_EQ(Y::constructed_counter, 1);   // 新しいオブジェクトが生成されるわけではない

            ASSERT_EQ(y0->WhoYouAre(), "Y with X"); // y0.x_はXオブジェクトを持っている
            ASSERT_EQ(x0->WhoYouAre(), "X with Y"); // x0.y_はYオブジェクトを持っている

            ASSERT_EQ(y0->WhoIsWith(), "X with Y"); // y0.x_はXオブジェクトを持っている
            ASSERT_EQ(x0->WhoIsWith(), "Y with X"); // x0.y_はYオブジェクトを持っている

            // 現時点で、x0とy0がお互いを持ち合う状態であることが確認できた

下記のコードでは、y0がスコープアウトするが、そのタイミングでは、x0はまだ健在であるため、 Yオブジェクトの参照カウントは1になる(x0::y_が存在するため0にならない)。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 192

            ASSERT_EQ(x0.use_count(), 2);           // x0、y0が相互に参照するので参照カウントが2に
            ASSERT_EQ(y0.use_count(), 2);           // x0、y0が相互に参照するので参照カウントが2に
            ASSERT_EQ(y0->ref_x().use_count(), 2);  // y0.x_の参照カウントは2
            ASSERT_EQ(x0->ref_y().use_count(), 2);  // x0.y_の参照カウントは2
        }  //ここでy0がスコープアウトするため、y0にはアクセスできないが、
           //x0を介して、y0が持っていたYオブジェクトにはアクセスできる

        ASSERT_EQ(x0->ref_y().use_count(), 1);  // y0がスコープアウトしたため、Yオブジェクトの参照カウントが減った
        ASSERT_EQ(x0->ref_y()->WhoYouAre(), "Y with X");  // x0.y_はXオブジェクトを持っている

ここでの状態をまとめると、

次のコードでは、x0がスコープアウトし、y0がもともと持っていたXオブジェクトは健在であるため、 Xオブジェクトの参照カウントも1になる。このため、x0、y0がスコープアウトした状態でも、 X、Yオブジェクトの参照カウントは0にならず、従ってこれらのオブジェクトは解放されない (shared_ptrは参照カウントが1->0に変化するタイミングで保持するオブジェクトを解放する)。

    //  example/term_explanation/shared_ptr_cycle_ut.cpp 204
    }  // この次の行で、x0はスコープアウトするため、x0にはアクセスできず、すでにy0にもアクセスできない
    // ここではx0、y0がもともと持っていたXオブジェクト、Yオブジェクトへのポインタを完全に失ってしまった状態

    ASSERT_EQ(X::constructed_counter, 1);  // Xオブジェクトは未開放であり、リークが発生
    ASSERT_EQ(Y::constructed_counter, 1);  // Yオブジェクトは未開放であり、リークが発生

X、Yオブジェクトへのハンドルを完全に失った状態であり、X、Yオブジェクトを解放する手段はない。

std::weak_ptr

std::weak_ptrは、スマートポインタの一種である。

std::weak_ptrは参照カウントに影響を与えず、shared_ptrとオブジェクトを共有所有するのではなく、 そのshared_ptrインスタンスとの関連のみを保持するのため、オブジェクトの循環所有の問題を解決できる。

オブジェクトの循環所有で示した問題のあるクラスの修正版を以下に示す (以下の例では、Xは前のままで、Yのみ修正した)。

    //  example/term_explanation/weak_ptr_ut.cpp 9

    class Y;
    class X final {
    public:
        explicit X() noexcept { ++constructed_counter; }
        ~X() { --constructed_counter; }

        void Register(std::shared_ptr<Y> y) { y_ = y; }

        std::shared_ptr<Y> const& ref_y() const noexcept { return y_; }

        // 自身の状態を返す ("X alone" または "X with Y")
        std::string WhoYouAre() const;

        // y_が保持するオブジェクトの状態を返す ("None" またはY::WhoYouAre()に委譲)
        std::string WhoIsWith() const;

        static uint32_t constructed_counter;

    private:
        std::shared_ptr<Y> y_{};  // 初期化状態では、y_はオブジェクトを所有しない(use_count()==0)
    };

    class Y final {
    public:
        explicit Y() noexcept { ++constructed_counter; }
        ~Y() { --constructed_counter; }

        void Register(std::shared_ptr<X> x) { x_ = x; }

        std::weak_ptr<X> const& ref_x() const noexcept { return x_; }

        // 自身の状態を返す ("Y alone" または "Y with X")
        std::string WhoYouAre() const;

        // x_が保持するオブジェクトの状態を返す ("None" またはY::WhoYouAre()に委譲)
        std::string WhoIsWith() const;

        static uint32_t constructed_counter;

    private:
        std::weak_ptr<X> x_{};
    };

    // Xのメンバ定義
    std::string X::WhoYouAre() const { return y_ ? "X with Y" : "X alone"; }
    std::string X::WhoIsWith() const { return y_ ? y_->WhoYouAre() : std::string{"None"}; }
    uint32_t    X::constructed_counter;

    // Yのメンバ定義
    std::string Y::WhoYouAre() const { return x_.use_count() != 0 ? "Y with X" : "Y alone"; }
    // 注: weak_ptrはbool変換をサポートしないため、use_count() != 0 で有効性を判定
    std::string Y::WhoIsWith() const  // 修正版Y::WhoIsWithの定義
    {
        if (auto x = x_.lock(); x) {  // Xオブジェクトが解放されていた場合、xはstd::shared_ptr<X>{}となり、falseと評価される
            return x->WhoYouAre();
        }
        else {
            return "None";
        }
    }
    uint32_t Y::constructed_counter;

このコードからわかるように修正版YはXオブジェクトを参照するために、 std::shared_ptr<X>の代わりにstd::weak_ptr<X>を使用する。 Xオブジェクトにアクセスする必要があるときに、 下記のY::WhoIsWith()関数の内部処理のようにすることで、std::weak_ptr<X>オブジェクトから、 それと紐づいたstd::shared_ptr<X>オブジェクトを生成できる。

なお、上記コードは初期化付きif文を使うことで、 生成したstd::shared_ptr<X>オブジェクトのスコープを最小に留めている。

    //  example/term_explanation/weak_ptr_ut.cpp 63
    std::string Y::WhoIsWith() const  // 修正版Y::WhoIsWithの定義
    {
        if (auto x = x_.lock(); x) {  // Xオブジェクトが解放されていた場合、xはstd::shared_ptr<X>{}となり、falseと評価される
            return x->WhoYouAre();
        }
        else {
            return "None";
        }
    }

Xと修正版Yの単体テストによりメモリーリークが修正されたことを以下に示す。

    //  example/term_explanation/weak_ptr_ut.cpp 82

    {
        ASSERT_EQ(X::constructed_counter, 0);
        ASSERT_EQ(Y::constructed_counter, 0);

        auto x0 = std::make_shared<X>();       // Xオブジェクトを持つshared_ptrの生成
        ASSERT_EQ(X::constructed_counter, 1);  // Xオブジェクトは1つ生成された

        ASSERT_EQ(x0.use_count(), 1);
        ASSERT_EQ(x0->WhoYouAre(), "X alone");  // x0.y_は何も保持していないので、"X alone"
        ASSERT_EQ(x0->ref_y().use_count(), 0);  // X::y_は何も持っていない

        {
            auto y0 = std::make_shared<Y>();

            ASSERT_EQ(Y::constructed_counter, 1);       // Yオブジェクトは1つ生成された
            ASSERT_EQ(y0.use_count(), 1);
            ASSERT_EQ(y0->ref_x().use_count(), 0);      // y0.x_は何も持っていない
            ASSERT_EQ(y0->WhoYouAre(), "Y alone");      // y0.x_は何も持っていないので、"Y alone"

            x0->Register(y0);                           // これによりx0.y_はy0と同じオブジェクトを持つ
            ASSERT_EQ(x0->WhoYouAre(), "X with Y");     // x0.y_はYオブジェクトを持っている

            y0->Register(x0);  // これによりy0.x_はx0と同じXオブジェクトを持つことができる
            ASSERT_EQ(y0->WhoIsWith(), "X with Y");     // y0.x_が持っているXオブジェクトはYを持っている
            
            // x0->Register(y0), y0->Register(x0)により Xオブジェクト、Yオブジェクトは相互参照できる状態となった
            ASSERT_EQ(X::constructed_counter, 1);       // 新しいオブジェクトが生成されるわけではない
            ASSERT_EQ(Y::constructed_counter, 1);       // 新しいオブジェクトが生成されるわけではない

            ASSERT_EQ(y0->WhoYouAre(), "Y with X");     // y0.x_はXオブジェクトを持っている
            ASSERT_EQ(x0->WhoYouAre(), "X with Y");     // x0.y_はYオブジェクトを持っている(再確認)
            ASSERT_EQ(y0->WhoIsWith(), "X with Y");     // y0が参照するXオブジェクトはYを持っている
            // 現時点で、x0とy0がお互いを相互参照できることが確認できた

            // weak_ptrを使用した効果によりXオブジェクトの参照カウントは増加しない
            ASSERT_EQ(x0.use_count(), 1);               // y0.x_はweak_ptrなので参照カウントに影響しない
            ASSERT_EQ(y0.use_count(), 2);               // x0.y_はshared_ptrなので参照カウントが2
            ASSERT_EQ(y0->ref_x().use_count(), 1);      // y0.x_の参照カウントは1
            ASSERT_EQ(x0->ref_y().use_count(), 2);      // x0.y_の参照カウントは2
        }  //ここでy0がスコープアウトするため、y0にはアクセスできないが、
           // x0を介して、y0が持っていたYオブジェクトにはアクセスできる

        ASSERT_EQ(x0->ref_y().use_count(), 1);  // y0がスコープアウトしたため、Yオブジェクトの参照カウントが減った
        ASSERT_EQ(x0->ref_y()->WhoYouAre(), "Y with X");  // x0.y_はXオブジェクトを持っている
    }  // この次の行で、x0はスコープアウトし、以下の処理が実行される:
       //   1. x0のデストラクタが呼ばれ、x0.y_の参照カウントがデクリメント
       //   2. x0.y_の参照カウントが1→0になり、保持していたYオブジェクトを解放する
       //   3. Yオブジェクトのデストラクタ内でy_.x_(weak_ptr)が破棄されるが、weak_ptrなのでXオブジェクトの参照カウントには影響しない
       //   4. x0本体のデストラクタが完了し、Xオブジェクトの参照カウントが1→0になり、Xオブジェクトも解放される

    // 上記1-4によりダイナミックに生成されたオブジェクトは解放されたため、下記のテストが成立する
    ASSERT_EQ(X::constructed_counter, 0);
    ASSERT_EQ(Y::constructed_counter, 0);

上記コード例で見てきたようにstd::weak_ptrを使用することで:

オブジェクトのライフタイム

オブジェクトは、以下のような種類のライフタイムを持つ。

なお、リファレンスの初期化をrvalueで行った場合、 そのrvalueはリファレンスがスコープを抜けるまで存続し続ける。

rvalueをバインドするリファレンスが存在しない状態で、 そのrvalueがメンバ変数へのリファレンスを返す関数を呼び出し、 そのリファレンスをバインドするリファレンス変数を初期化した場合、 リファレンスが指すオブジェクトはすでにライフタイムを終了している。 このような状態のリファレンスをdanglingリファレンスと呼ぶ。 同様に、このような状態のポインタをdanglingポインタと呼ぶ。

オブジェクトのコピー

シャローコピー

シャローコピー(浅いコピー)とは、暗黙的、 もしくは=defaultによってコンパイラが生成するようなcopyコンストラクタ、 copy代入演算子が行うコピーであり、ディープコピーと対比的に使われる概念である。

以下のクラスShallowOKには、コンパイラが生成するcopyコンストラクタ、 copy代入演算子と同等なものを定義したが、これは問題のないシャローコピーである (が、正しく自動生成される関数を実装すると、メンバ変数が増えた際にバグを生み出すことがあるため、 実践的にはこのようなことはすべきではない)。

    //  example/term_explanation/deep_shallow_copy_ut.cpp 7

    class ShallowOK {
    public:
        explicit ShallowOK(char const* str = "") : str_{std::string{str}} {}
        std::string const& GetString() const noexcept { return str_; }

        // 下記2関数を定義しなければ、以下と同等なcopyコンストラクタ、copy代入演算子が定義される。
        ShallowOK(ShallowOK const& rhs) : str_{rhs.str_} {}

        ShallowOK& operator=(ShallowOK const& rhs)
        {
            str_ = rhs.str_;
            return *this;
        }

    private:
        std::string str_;
    };

コンストラクタでポインタのようなリソースを確保し、 デストラクタでそれらを解放するようなクラスの場合、シャローコピーは良く知られた問題を起こす。

下記のShallowNGはその例である。

    //  example/term_explanation/deep_shallow_copy_ut.cpp 43

    class ShallowNG {
    public:
        explicit ShallowNG(char const* str = "") : str_{new std::string{str}} {}
        ~ShallowNG() { delete str_; }
        std::string const& GetString() const noexcept { return *str_; }

    private:
        std::string* str_;
    };

シャローコピーにより、メンバで保持していたポインタ(ポインタが指しているオブジェクトではない) がコピーされてしまうため、下記のコード内のコメントで示した通り、 メモリリークや2重解放を起こしてしまう。

    //  example/term_explanation/deep_shallow_copy_ut.cpp 60

    auto const s0 = ShallowNG{"s0"};

    // NG s0.str_とs1.str_は同じメモリを指すため~ShallowNG()に2重解放される。
    auto const s1 = ShallowNG{s0};

    auto s2 = ShallowNG{"s2"};

    // NG s2.str_が元々保持していたメモリは、解放できなくなる。
    s2 = s0;

    // NG s0.str_とs2.str_は同じメモリを指すため、
    //    s0、s2のスコープアウト時に、~ShallowNG()により、2重解放される。

ディープコピー

ディープコピーとは、シャローコピーが発生させる問題を回避したコピーである。

以下に例を示す。

    //  example/term_explanation/deep_shallow_copy_ut.cpp 79

    class Deep {
    public:
        explicit Deep(char const* str = "") : str_{new std::string{str}} {}
        ~Deep() { delete str_; }
        std::string const& GetString() const noexcept { return *str_; }

        // copyコンストラクタの実装例
        Deep(Deep const& rhs) : str_{new std::string{*rhs.str_}} {}

        // copy代入演算子の実装例
        Deep& operator=(Deep const& rhs)
        {
            *str_ = *(rhs.str_);
            return *this;
        }

    private:
        std::string* str_;
    };

    class Deep2 {  // std::unique_ptrを使いDeepをリファクタリング
    public:
        explicit Deep2(char const* str = "") : str_{std::make_unique<std::string>(str)} {}
        std::string const& GetString() const { return *str_; }

        // copyコンストラクタの実装例
        Deep2(Deep2 const& rhs) : str_{std::make_unique<std::string>(*rhs.str_)} {}

        // copy代入演算子の実装例
        Deep2& operator=(Deep2 const& rhs)
        {
            *str_ = *(rhs.str_);
            return *this;
        }

    private:
        std::unique_ptr<std::string> str_;
    };

上記クラスのDeepは、copyコンストラクタ、copy代入演算子でポインタをコピーするのではなく、 ポインタが指しているオブジェクトを複製することにより、シャローコピーの問題を防ぐ。

スライシング

オブジェクトのスライシングとは、

が宣言されたとした場合、

    d2_ref = d1;    // オブジェクトの代入

を実行した時に発生するようなオブジェクトの部分コピーのことである (この問題はリファレンスをポインタに代えた場合にも起こる)。

以下のクラスと単体テストはこの現象を表している。

    //  example/term_explanation/slice_ut.cpp 10

    class Base {
    public:
        explicit Base(char const* name) noexcept : name0_{name} {}
        char const* Name0() const noexcept { return name0_; }

        // ...
    private:
        char const* name0_;
    };

    class Derived final : public Base {
    public:
        Derived(char const* name0, char const* name1) noexcept : Base{name0}, name1_{name1} {}
        char const* Name1() const noexcept { return name1_; }

        // ...
    private:
        char const* name1_;
    };
    //  example/term_explanation/slice_ut.cpp 41

    auto const d0     = Derived{"d0", "d0"};
    auto const d1     = Derived{"d1", "d1"};
    auto       d2     = Derived{"d2", "d2"};
    Base&      d2_ref = d2;

    ASSERT_STREQ("d2", d2.Name0());  // OK
    ASSERT_STREQ("d2", d2.Name1());  // OK

    d2 = d0;
    ASSERT_STREQ("d0", d2.Name0());  // OK
    ASSERT_STREQ("d0", d2.Name1());  // OK

    d2_ref = d1;                     // d2_refはBase&型で、d2へのリファレンス
    ASSERT_STREQ("d1", d2.Name0());  // OK
    /*  本来なら↓が成立してほしいが.、、、
    ASSERT_STREQ("d1", d2.Name1()); */
    ASSERT_STREQ("d0", d2.Name1());  // スライシングの影響でDerived::name1_はコピーされない

copy代入演算子(=)によりコピーが行われた場合、=の両辺のオブジェクトは等価になるべきだが (copy代入演算子をオーバーロードした場合も、そうなるように定義すべきである)、 スライシングが起こった場合、そうならないことが問題である(「等価性のセマンティクス」参照)。

下記にこの現象の発生メカニズムについて解説する。

  1. 上記クラスBase、Derivedのメモリ上のレイアウトは下記のようになる。

  1. 上記インスタンスd0、d1、d2、d2_refのメモリ上のレイアウトは下記のようになる。

  1. d2 = d0をした場合の状態は下記のようになる。

  1. 上記の状態でd2_ref = d1をした場合の状態は下記のようになる。

d2.name1_の値が元のままであるが(これがスライシングである)、その理由は下記の疑似コードが示す通り、 「d2_refの表層型がクラスBaseであるためd1もクラスBase(正確にはBase型へのリファレンス)へ変換された後、 d2_refが指しているオブジェクト(d2)へコピーされた」からである。

    d2_ref.Base::operator=(d1);   // Base::operator=(Base const&)が呼び出される
                                  // 関数Base::operator=(Base const&)の中では、
                                  // d1の型はBase型のリファレンスとなる

次に示すのは、 「オブジェクトの配列をその基底クラスへのポインタに代入し、 そのポインタを配列のように使用した場合に発生する」スライシングと類似の現象である。

    //  example/term_explanation/slice_ut.cpp 64

    Derived d_array[]{{"0", "1"}, {"2", "3"}};
    Base*   b_ptr = d_array;  // この代入までは問題ないが、b_ptr[1]でのアクセスで問題が起こる

    ASSERT_STREQ("0", d_array[0].Name0());  // OK
    ASSERT_STREQ("0", b_ptr[0].Name0());    // OK

    ASSERT_STREQ("2", d_array[1].Name0());  // OK
    /* スライシングに類似した問題で、以下のテストは失敗する。
    ASSERT_STREQ("2", b_ptr[1].Name0());    NG */
    // こうすればテストは通るが、、、
    ASSERT_STREQ("1", b_ptr[1].Name0());  // NG

リテラル

プログラムに具体的な値を与えるための基本的な即値を指す。 例えば、1, 2, 1.0, true/false, nullptr, “literal string”など。

生文字列リテラル

下記の例にあるように正規表現をそのまま文字列リテラルとして表現するために、 C++11から導入された導入されたリテラル。

    //  example/term_explanation/literal_ut.cpp 15

        std::regex raw_re{R"(\d+)"};     // 生文字リテラルで正規表現パターン。\のエスケープが不要
        std::regex normal_re{"(\\d+)"};  // 生文字リテラルで正規表現パターン。\のエスケープが必要

        std::string test_str = "The year is 2024";  // テスト対象の文字列

        {
            std::smatch match;
            ASSERT_TRUE(std::regex_search(test_str, match, raw_re));  // 正規表現で数字部分を検索
            ASSERT_EQ(match.str(), "2024");  // マッチした部分が "2024" であることをチェック
        }
        {
            std::smatch match;
            ASSERT_TRUE(std::regex_search(test_str, match, normal_re));  // 正規表現で数字部分を検索
            ASSERT_EQ(match.str(), "2024");  // マッチした部分が "2024" であることをチェック
        }

2進数リテラル

C++14以降では、0bまたは 0B をプレフィックスとして使うことで、2進数リテラルを表現できる。

    //  example/term_explanation/literal_ut.cpp 36

    int bin_value = 0b1101;  // 2進数リテラル  2進数1101 は10進数で 13
    ASSERT_EQ(bin_value, 13);

数値リテラル

C++14では区切り文字’を使用し、数値リテラルを記述できるようになった。

    //  example/term_explanation/literal_ut.cpp 42

    // 区切り文字を使った数値リテラル
    int large_number = 1'000'000;  // 10進数は3桁で区切るとわかりやすい
    ASSERT_EQ(large_number, 1000000);

    int bin_with_separator = 0b1011'0010;  // 10進数は4桁で区切るとわかりやすい
    ASSERT_EQ(bin_with_separator, 178);    // 2進数 1011 0010 は 10進数で 178

    int hex_with_separator = 0x00'00'ff'ff;  // 16進数は2桁で区切るとわかりやすい
    ASSERT_EQ(hex_with_separator, 65535);    // 16進数 0x00010011 == 65535

ワイド文字列

ワイド文字列リテラルを保持する型は下記のように定義された。

    //  example/term_explanation/literal_ut.cpp 59

        // UTF-16 文字列リテラル(uプレフィックスを使用)
        char16_t       utf16_str[]  = u"こんにちは";
        std::u16string utf16_string = u"こんにちは";  // UTF-16 std::u16string 型

        // UTF-32 文字列リテラル(Uプレフィックスを使用)
        char32_t       utf32_str[]  = U"こんにちは";
        std::u32string utf32_string = U"こんにちは";  // UTF-32 std::u32string 型

    #if __cplusplus >= 202002L  // c++20
        // UTF-8 文字列リテラル(u8プレフィックスを使用)
        const char8_t* utf8_str    = u8"こんにちは";
        std::u8string  utf8_string = u8"こんにちは";  // UTF-8 std::string 型

    #else // c++17
        // UTF-8 文字列リテラル(u8プレフィックスを使用)
        const char* utf8_str    = "こんにちは";
        std::string utf8_string = "こんにちは";  // UTF-8 std::string 型
    #endif

16進浮動小数点数リテラル

16進浮動小数点数リテラルは、 C++17から導入された浮動小数点数を16進数で表現する方法である。 特に、ハードウェアや低レベルのプログラミングで、 浮動小数点数の内部表現を直接扱う際に便利である

    一般的な形式:
        0x[数字].[数字]p[指数]
        0x: 16進数を表すプレフィックス
        [数字]: 16進数の数字 (0-9, a-f, A-F)
        .: 小数点
        p: 指数部を表す
        [指数]: 10進数の指数

    例:
        0x1.2p3は下記に解説する

    リテラルの構成:
        0x: 16進数の開始を示す。
        1.2: 仮数部を表す。この部分は16進数。
        p3: 指数部を表す。この場合、2の3乗を意味すため、つまり8。

        1.2(16進数) =  1 + 2 / 16 = 1.125(10進数)
        1.125 * 8 = 9.0
    //  example/term_explanation/literal_ut.cpp 87

    // float型
    float hex_float = 0x1.2p3;
    EXPECT_FLOAT_EQ(hex_float, 9.0f);  // 正しい期待値は9.0f

    // double型
    double hex_double = 0x1.2p3;
    EXPECT_DOUBLE_EQ(hex_double, 9.0);  // 正しい期待値は9.0

    // 指数部が負の場合 (double型)
    double negative_exp = 0x1.2p-2;
    EXPECT_DOUBLE_EQ(negative_exp, 0.28125);  // 期待値は正しい

    // 小数点以下の部分がない場合 (double型)
    double integer_part = 0x1p3;
    EXPECT_DOUBLE_EQ(integer_part, 8.0);  // 期待値は正しい

    EXPECT_FLOAT_EQ(static_cast<float>(hex_double), hex_float);  // double型をfloatにキャスト

ユーザー定義リテラル

ユーザ定義リテラル演算子により定義されたリテラルを指す。

ユーザ定義リテラル演算子

ユーザ定義リテラル演算子とは以下のようなものである。

    //  example/term_explanation/user_defined_literal_ut.cpp 4

    constexpr int32_t one_km = 1000;

    // ユーザ定義リテラル演算子の定義
    constexpr int32_t operator""_kilo_meter(unsigned long long num_by_mk) { return num_by_mk * one_km; }
    constexpr int32_t operator""_meter(unsigned long long num_by_m) { return num_by_m; }
    //  example/term_explanation/user_defined_literal_ut.cpp 15

    int32_t km = 3_kilo_meter;  // ユーザ定義リテラル演算子の利用
    int32_t m  = 3000_meter;    // ユーザ定義リテラル演算子の利用

    ASSERT_EQ(m, km);

std::string型リテラル

“xxx”sとすることで、std::string型のリテラルを作ることができる。

    //  example/term_explanation/user_defined_literal_ut.cpp 26

    using namespace std::literals::string_literals;

    auto a = "str"s;  // aはstd::string
    auto b = "str";   // bはconst char*

    static_assert(std::is_same_v<decltype(a), std::string>);
    ASSERT_EQ(std::string{"str"}, a);

    static_assert(std::is_same_v<decltype(b), char const*>);
    ASSERT_STREQ("str", b);

std::chronoのリテラル

std::chronoのリテラルは以下のコードのように使用できる。

    //  example/term_explanation/literal_ut.cpp 109

    using namespace std::chrono_literals;

    static_assert(1s == 1000ms);  // 1秒 (1s) は 1000 ミリ秒 (1000ms) と等しい

    static_assert(1min == 60s);  // 1分 (1min) は 60秒 (60s) と等しい

    static_assert(1h == 3600s);  // 1時間 (1h) は 3600秒 (3600s) と等しい

    static_assert(1.5s == 1500ms);  // 小数点を使った時間リテラル

std::complexリテラル

std::complexリテラル以下のコードのように使用できる。

    //  example/term_explanation/literal_ut.cpp 124

    using namespace std::complex_literals;  // 複素数リテラルを使うための名前空間

    auto a = 1.0 + 2.0i;  // std::complex<double>
    auto b = 3.0 + 4.0i;  // std::complex<double>

    auto result = a + b;
    EXPECT_EQ(result.real(), 4.0);
    EXPECT_EQ(result.imag(), 6.0);
    EXPECT_EQ(result, 4.0 + 6.0i);

==演算子

クラスの==演算子の実装方法には、 メンバ==演算子非メンバ==演算子の2つの方法がある。

メンバ==演算子

メンバ==演算子には、非メンバ==演算子に比べ、下記のようなメリットがある。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 12

    class Integer {
    public:
        Integer(int x) noexcept : x_{x} {}

        // operator==とoperator<だけを定義
        int get() const noexcept { return x_; }

        // メンバ関数の比較演算子
        bool operator==(const Integer& other) const noexcept { return x_ == other.x_; }
        bool operator<(const Integer& other) const noexcept { return x_ < other.x_; }

    private:
        int x_;
    };

すべてのメンバ変数に==演算子が定義されている場合、 C++20以降より、=defaultにより==演算子を自動生成させることができるようになった。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 217

    class Integer {
    public:
        Integer(int x) noexcept : x_{x} {}

        bool operator==(const Integer& other) const noexcept = default;  // 自動生成

    private:
        int x_;
    };

非メンバ==演算子

非メンバ==演算子には、メンバ==演算子に比べ、下記のようなメリットがある。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 56

    class Integer {
    public:
        Integer(int x) noexcept : x_{x} {}

        // operator==とoperator<だけを定義
        int get() const noexcept { return x_; }

        // メンバ関数の比較演算子に見えるが、非メンバ関数
        friend bool operator==(const Integer& lhs, const Integer& rhs) noexcept { return lhs.x_ == rhs.x_; }

        friend bool operator<(const Integer& lhs, const Integer& rhs) noexcept { return lhs.x_ < rhs.x_; }

    private:
        int x_;
    };
    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 78

    auto a = Integer{5};

    ASSERT_TRUE(5 == a);  // 5がInteger{5}に型型変換される

すべてのメンバ変数に==演算子が定義されている場合、 C++20以降より、=defaultにより==演算子を自動生成させることができるようになった。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 241

    class Integer {
    public:
        Integer(int x) noexcept : x_{x} {}

        friend bool operator==(Integer const& lhs, Integer const& rhs) noexcept;

    private:
        int x_;
    };

    bool operator==(Integer const& lhs, Integer const& rhs) noexcept = default;  // 自動生成

比較演算子

比較演算子とは、==演算子の他に、!=、 <=、>、>= <、>を指す。 C++20から導入された<=>演算子の定義により、すべてが定義される。

std::rel_ops

クラスにoperator==operator<の2つの演算子が定義されていれば、 それがメンバか否かにかかわらず、他の比較演算子 !=、<=、>、>= はこれらを基に自動的に導出できる。 std::rel_opsではoperator==operator<= を基に他の比較演算子を機械的に生成する仕組みが提供されている。

次の例では、std::rel_opsを利用して、少ないコードで全ての比較演算子をサポートする例を示す。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 32

    using namespace std::rel_ops;  // std::rel_opsを使うために名前空間を追加

    auto a = Integer{5};
    auto b = Integer{10};
    auto c = Integer{5};

    // std::rel_opsとは無関係に直接定義
    ASSERT_EQ(a, c);      // a == c
    ASSERT_NE(a, b);      // a != c
    ASSERT_TRUE(a < b);   // aはbより小さい
    ASSERT_FALSE(b < a);  // bはaより小さくない

    // std::rel_ops による!=, <=, >, >=の定義
    ASSERT_TRUE(a != b);   // aとbは異なる
    ASSERT_TRUE(a <= b);   // aはb以下
    ASSERT_TRUE(b > a);    // bはaより大きい
    ASSERT_FALSE(a >= b);  // aはb以上ではない

なお、std::rel_opsはC++20から導入された<=>演算子により不要になったため、 非推奨とされた。

std::tuppleを使用した比較演算子の実装方法

クラスのメンバが多い場合、==演算子で示したような方法は、 可読性、保守性の問題が発生する場合が多い。下記に示す方法はこの問題を幾分緩和する。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 110

    struct Point {
        int x;
        int y;

        bool operator==(const Point& other) const noexcept { return std::tie(x, y) == std::tie(other.x, other.y); }

        bool operator<(const Point& other) const noexcept { return std::tie(x, y) < std::tie(other.x, other.y); }
    };
    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 124

        auto a = Point{1, 2};
        auto b = Point{1, 3};
        auto c = Point{1, 2};

        using namespace std::rel_ops;  // std::rel_opsを使うために名前空間を追加

        ASSERT_TRUE(a == c);
        ASSERT_TRUE(a != b);
        ASSERT_TRUE(a < b);
        ASSERT_FALSE(a > b);

<=>演算子

std::tuppleを使用した比較演算子の実装方法」 で示した定型のコードはコンパイラが自動生成するのがC++規格のセオリーである。 このためC++20から導入されたのが<=>演算子<=>である。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 141

    struct Point {
        int x;
        int y;

        auto operator<=>(const Point& other) const noexcept = default;  // 三方比較演算子 (C++20)
        // 通常autoとするが、実際の戻り型はstd::strong_ordering
    };
    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 154

    auto p1 = Point{1, 2};
    auto p2 = Point{1, 2};
    auto p3 = Point{2, 3};

    ASSERT_EQ(p1, p2);  // p1 == p2
    ASSERT_NE(p1, p3);  // p1 != p3
    ASSERT_TRUE(p1 < p3);
    ASSERT_FALSE(p1 > p3);

    auto cmp_1_2 = p1 <=> p2;
    auto cmp_1_3 = p1 <=> p3;
    auto cmp_3_1 = p3 <=> p1;
    static_assert(std::is_same_v<std::strong_ordering, decltype(cmp_1_2)>);

    ASSERT_EQ(std::strong_ordering::equal, cmp_1_2);    // 等しい
    ASSERT_EQ(std::strong_ordering::less, cmp_1_3);     // <=>の左オペランドが小さい
    ASSERT_EQ(std::strong_ordering::greater, cmp_3_1);  // <=>の左オペランドが大きい

    // std::strong_orderingの値
    // ASSERT_EQ(static_cast<int32_t>(cmp_1_2), 0); キャストできないのでコンパイルエラー
    ASSERT_TRUE(cmp_1_2 == 0);
    ASSERT_TRUE(cmp_1_3 < 0);  // cmp_1_3は実質的には-1
    ASSERT_TRUE(cmp_3_1 > 0);  // cmp_3_1は実質的には1

定型の比較演算子では不十分である場合、<=>演算子を実装する必要が出てくる。 そのような場合に備えて、上記の自動生成コードの内容を敢えて実装して、以下に示す。

    //  example/term_explanation_cpp20/comparison_operator_ut.cpp 185

    struct Point {
        int x;
        int y;

        std::strong_ordering operator<=>(const Point& other) const noexcept
        {
            return std::tie(x, y) <=> std::tie(other.x, other.y);
        }

        bool operator==(const Point& other) const noexcept { return std::tie(x, y) == std::tie(other.x, other.y); }
    };

三方比較演算子

三方比較演算子とは<=>演算子を指す。

spaceship operator

spaceship operatorとは<=>演算子を指す。 この名前は<=>が宇宙船に見えることに由来としている。

構文

属性構文

C++14から導入されたの属性構文は、[[属性名]]の形式で記述され、 特定のコード要素に対する追加情報やコンパイラへの指示を与えるためのものである。

属性 C++Ver 効果
[[noreturn]] C++11 関数が決して返らないことを示す
[[deprecated]] C++14 関数や変数が非推奨であることを示しめす
[[maybe_unused]] C++17 変数や関数が未使用である警告の抑止
[[nodiscard]] C++17 戻り値が無視されると警告
[[fallthrough]] C++14 switch文のfallthroughの警告抑止
[[no_unique_address]] C++20 クラスや構造体のメンバに対して、メモリの最適化促進
    //  example/term_explanation/attr_ut.cpp 10

    // 非推奨の関数
    [[deprecated("この関数は非推奨です。代わりに newFunction を使用してください。")]]  // 
    void oldFunction();  // この関数を呼び出すと警告される
    void newFunction();
    //  example/term_explanation/attr_ut.cpp 20
    void processValues()
    {
        [[maybe_unused]] int unusedValue = 42;  // 使用しない変数でも警告が出ない

        // do something
    }
    //  example/term_explanation/attr_ut.cpp 28

    [[nodiscard]] int computeResult() { return 42; }

    //  example/term_explanation/attr_ut.cpp 38

    computeResult();               // 警告が出る:戻り値が無視されている
    int result = computeResult();  // これはOK
    //  example/term_explanation/attr_ut.cpp 54

    switch (value) {
    case 1:
        // do something
        [[fallthrough]];  // 明示的に fallthrough を宣言することができる
    case 2:
        // do something
        break;
    default:
        break;
    }

関数tryブロック

関数tryブロックとはtry-catchを本体とした下記のような関数のブロックを指す。

    //  example/term_explanation/func_try_block.cpp 8

    void function_try_block()
    try {  // 関数tryブロック
        // 何らかの処理
        // ...
    }
    catch (std::length_error const& e) {  // 関数tryブロックのエクセプションハンドラ
        // ...
    }
    catch (std::logic_error const& e) {  // 関数tryブロックのエクセプションハンドラ
        // ...
    }

範囲for文

範囲for文は、

    for ( for-range-declaration : for-range-initializer ) statement

このような形式で表され、C++17までは下記のような疑似コードに展開される。

    {
        auto && __range = for-range-initializer;
        for ( auto __begin = begin-expr, __end = end-expr; __begin != __end; ++__begin ) {
        for-range-declaration = *__begin;
        statement
      }
    }

単純な範囲for文の使用例は下記の通りである。

    //  example/term_explanation/range_for_ut.cpp 14

    auto list = std::list{1, 2, 3};
    auto oss  = std::stringstream{};

    for (auto a : list) {  // 範囲for文
        oss << a;
    }
    ASSERT_EQ(oss.str(), "123");

上記のコードは下記のように展開される。

    //  example/term_explanation/range_for_ut.cpp 26

    auto list = std::list{1, 2, 3};
    auto oss  = std::stringstream{};

    // std::begin(list)、std::end(list)の戻り型が同一
    static_assert(std::is_same_v<decltype(std::begin(list)), decltype(std::end(list))>);

    // 上記の範囲for文は下記のように展開される
    for (auto it = std::begin(list); it != std::end(list); ++it) {
        oss << *it;
    }

    ASSERT_EQ(oss.str(), "123");

C++17以前は、上記のコードのコメントにある通り、__begin__endが同一の型である前提であった。 C++17以降は、この規制が緩和されたため、以下のように展開されることになった。

    {
        auto && __range = for-range-initializer;
        auto __begin = begin-expr;
        auto __end = end-expr;     // C++17までは、__begin と __endは同一である前提
        for ( ; __begin != __end; ++__begin ) {
            for-range-declaration = *__begin;
            statement
        }
    }

この規制緩和により、以下のようなコードが範囲for文で記述できるようになった。 下記のコードはこの緩和ルールの応用例である。

    //  example/term_explanation/range_for_ut.cpp 73

    delimited_string<','> delimited_str{"Hello,World"};
    std::ostringstream    oss;

    // ',' を終了文字として "Hello" だけをループして出力
    for (auto c : delimited_str) {
        oss << c;
    }

    ASSERT_EQ("Hello", oss.str());  // 結果は "Hello" になるはず

上記のコードは下記のように展開される。

    //  example/term_explanation/range_for_ut.cpp 87

    delimited_string<','> delimited_str{"Hello,World"};
    std::ostringstream    oss;

    // ',' を終了文字として"Hello" だけをループして出力
    for (auto it = delimited_str.begin(); it != delimited_str.end(); ++it) {
        oss << *it;
    }

    ASSERT_EQ("Hello", oss.str());  // 結果は "Hello" になるはず

構造化束縛

構造化束縛はC++17 から導入されたもので、std::tuppleやstd::pair、std::arrayなど、 構造体のメンバーを個別の変数に分解して簡潔に扱うことをできるようにするための機能である。

    //  example/term_explanation/structured_binding_ut.cpp 13

        // tupleでの構造化束縛の例
        std::tuple<int, double, std::string> tobj(1, 2.5, "Hello");

        auto [i, d, s] = tobj;  // 構造化束縛を使用してタプルを分解

        ASSERT_EQ(i, 1);
        ASSERT_DOUBLE_EQ(d, 2.5);
        ASSERT_EQ("Hello", s);
    //  example/term_explanation/structured_binding_ut.cpp 28

        // pairでの構造化束縛の例
        std::pair<int, std::string> pobj(42, "example");

        auto [i, s] = pobj;  // 構造化束縛を使用してペアを分解

        ASSERT_EQ(i, 42);
        ASSERT_EQ("example", s);
    //  example/term_explanation/structured_binding_ut.cpp 42

        struct Person {
            std::string name;
            int         age;
        };

        Person person{"Ichiro", 30};  // 構造体のインスタンス

        auto& [name, age] = person;  // 構造化束縛を使用して構造体のメンバーを分解

        static_assert(std::is_same_v<decltype(name), std::string>);  // これは正しい
        // static_assert(std::is_same_v<decltype(name), std::string&>); これはコンパイルエラー
        // 上記がコンパイルエラーになる理由は以下の通り。
        //
        // 変数宣言は、 autoを記述したあとに角カッコ内に変数名を列挙する。
        // それぞれの変数に対する型や修飾子の指定はできない。
        // autoの部分を const auto&のように、全体に対してCV修飾や参照を付加することはできる。
        // それぞれの変数の型は、各要素をdecltypeしたものとなる。
        //                        ^^^^^^^^^^^^^^ nameの型がstd::stringと評価された理由

        name = "Taro";  // nameはリファレンス
        age  = 56;      // ageはリファレンス
        ASSERT_EQ(person.name, "Taro");
        ASSERT_EQ(person.age, 56);
    //  example/term_explanation/structured_binding_ut.cpp 72

        auto array = std::array<int, 3>{1, 2, 3};

        auto [x, y, z] = array;  // 構造化束縛を使って std::array の要素を分解

        ASSERT_EQ(x, 1);
        ASSERT_EQ(y, 2);
        ASSERT_EQ(z, 3);

初期化付きif/switch文

C++17で、if文とswitc文に初期化を行う構文が導入された。 これにより、変数をそのスコープ内で初期化し、その変数を条件式の評価に使用できる。 初期化された変数は、if文やswitch文のスコープ内でのみ有効であり、他のスコープには影響を与えない。

この構文は、従来のfor文で使用されていた初期化ステートメントを、if/switch文に拡張したものである。 この類似性が理解しやすいように、本節では、 敢えて以下のコード例で同じ関数、同じクラスを使用し、 対比できるようにした。

初期化付きfor文(従来のfor文)

下記の疑似コードは従来のfor文の構造を表す。

    for (init-statement; condition; post-statement) {
        // ループ処理
    }

上記のと同様の実際のfor文のコードを以下に示す。

    //  example/term_explanation/if_switch_init_ut.cpp 8

    class OperationResult {
    public:
        enum class ErrorCode { NoError, ErrorPattern1, ErrorPattern2, ErrorPattern3 };
        bool      IsError() const noexcept;
        ErrorCode Get() const noexcept;
                  operator bool() const noexcept { return IsError(); }

    private:
        // 何らかの定義
    };

    OperationResult DoOperation();                                 // 何らかの処理
    void            RecoverOperation(OperationResult::ErrorCode);  // リカバリ処理
    //  example/term_explanation/if_switch_init_ut.cpp 33

    for (auto result = DoOperation(); result.IsError(); result = DoOperation()) {
        RecoverOperation(result.Get());  // エラー処理
    }

    // 以下、成功時の処理

初期化付きwhile文(従来のwhile文)

下記の疑似コードこの節で説明しようとしているwhile文の構造を表す(従来からのwhile文)。

    while (type-specifier-seq declarator) {
        // 条件がtrueの場合の処理
    }

初期化付きif文/初期化付きswitch文はC++17から導入されたシンタックスであるが、 それと同様のシンタックスはwhileには存在しないが、 以下のコード例のように従来の記法は広く知られているため、念とため紹介する。

    //  example/term_explanation/if_switch_init_ut.cpp 45

    while (auto result = DoOperation()) {  // resultはboolへの暗黙の型変換が行われる
        // エラー処理
    }
    // resultはスコープアウトする

初期化付きif文

下記の疑似コードこの節で説明しようとしているif文の構造を表す。

    if (init-statement; condition) {
        // 条件がtrueの場合の処理
    }

上記と同様の構造を持つ実際のif文のコードを以下に示す。

    //  example/term_explanation/if_switch_init_ut.cpp 8

    class OperationResult {
    public:
        enum class ErrorCode { NoError, ErrorPattern1, ErrorPattern2, ErrorPattern3 };
        bool      IsError() const noexcept;
        ErrorCode Get() const noexcept;
                  operator bool() const noexcept { return IsError(); }

    private:
        // 何らかの定義
    };

    OperationResult DoOperation();                                 // 何らかの処理
    void            RecoverOperation(OperationResult::ErrorCode);  // リカバリ処理
    //  example/term_explanation/if_switch_init_ut.cpp 56

    if (auto result = DoOperation(); !result.IsError()) {
        // 成功処理
    }
    else {
        RecoverOperation(result.Get());  // エラー処理
    }
    // resultはスコープアウトする

クラスの独自の<=>演算子を定義する場合、下記のように使用することができる。

    //  example/term_explanation/if_switch_init_ut.cpp 69

    struct DoubleName {
        std::string name0;
        std::string name1;
        friend bool operator==(DoubleName const& lhs, DoubleName const& rhs) noexcept = default;
    };

    inline auto operator<=>(DoubleName const& lhs, DoubleName const& rhs) noexcept
    {
        // name0 を比較し、等しくなければその比較結果を返す
        if (auto cmp = lhs.name0 <=> rhs.name0; cmp != 0) {
            return cmp;
        }

        return lhs.name1 <=> rhs.name1;  // name0が等しければ name1を比較
    }

初期化付きswitch文

下記の疑似コードはこの節で説明しようとしているswitch文の構造を表す。

    switch (init-statement; condition) {
        case value1:
            // 条件が value1 の場合の処理
            break;
        case value2:
            // 条件が value2 の場合の処理
            break;
        // その他のケース
    }

上記と同様の構造を持つ実際のswitch文のコードを以下に示す。

    //  example/term_explanation/if_switch_init_ut.cpp 8

    class OperationResult {
    public:
        enum class ErrorCode { NoError, ErrorPattern1, ErrorPattern2, ErrorPattern3 };
        bool      IsError() const noexcept;
        ErrorCode Get() const noexcept;
                  operator bool() const noexcept { return IsError(); }

    private:
        // 何らかの定義
    };

    OperationResult DoOperation();                                 // 何らかの処理
    void            RecoverOperation(OperationResult::ErrorCode);  // リカバリ処理
    //  example/term_explanation/if_switch_init_ut.cpp 100

    switch (auto result = DoOperation(); result.Get()) {
    case OperationResult::ErrorCode::ErrorPattern1:
        RecoverOperation(result.Get());  // エラー処理
        break;
        // エラー処理のいくつかのパターン
    case OperationResult::ErrorCode::NoError:
        // 成功処理
    default:
        assert(false);  // ここには来ないはず
    }
    // resultはスコープアウトする

言語機能

コルーチン

コルーチンはC++20から導入された機能であり、以下の新しいキーワードによりサポートされる。

co_await

co_awaitはコルーチンの非同期操作の一時停止と再開に使用される。 co_waitとco_returnを使用したコードを以下に示す。

    //  example/term_explanation_cpp20/co_await_ut.cpp 12

    class Task {  // コルーチンが返す型
    public:
        /// @struct promise_type
        /// @brief コルーチンのライフサイクルを管理する構造体
        struct promise_type {
            /// @brief コルーチンから Task 型のオブジェクトを返す関数
            /// @return Taskオブジェクト
            Task get_return_object() { return Task{std::coroutine_handle<promise_type>::from_promise(*this)}; }

            /// @brief コルーチンの最初のサスペンドポイント
            /// @return 常にサスペンドするオブジェクトを返す
            std::suspend_always initial_suspend() { return {}; }

            /// @brief コルーチンの最後のサスペンドポイント
            /// @return 常にサスペンドするオブジェクトを返す
            std::suspend_always final_suspend() noexcept { return {}; }

            /// @brief コルーチン内で例外が発生した場合に呼び出される
            /// @details コルーチン内で未処理の例外が発生した場合に、プロセスを終了する
            void unhandled_exception() { std::exit(1); }

            /// @brief コルーチンが終了した際に呼び出される
            /// @details co_return で値が返されない場合に呼び出されるが、何も行わない
            void return_void() {}
        };

        /// @brief Task のコンストラクタ
        /// @param h コルーチンハンドル
        Task(std::coroutine_handle<promise_type> h) : coro{h} {}

        /// @brief コルーチンの呼び出し回数に基づいた文字列を返す
        /// @return 呼び出し回数に応じた "call X" という文字列
        std::string get_value() { return "call " + std::to_string(called); }

        /// @brief コルーチンを再開する
        /// @details コルーチンが終了していなければ再開し、呼び出し回数をカウントする
        /// @return コルーチンが完了していなければ true、完了していれば false
        bool resume()
        {
            ++called;                 // コルーチンを呼び出した回数をカウント
            if (!coro.done()) {       // コルーチンが完了していなければ
                coro.resume();        // 再開
                return !coro.done();  // 再開後も完了していなければ true を返す
            }
            return false;  // すでに完了している場合は false を返す
        }

        /// @brief Task のデストラクタ
        /// @details コルーチンハンドルが有効であれば破棄する
        ~Task()
        {
            if (coro) coro.destroy();
        }

    private:
        std::coroutine_handle<promise_type> coro;        ///< コルーチンハンドル
        uint32_t                            called = 0;  ///< コルーチンが再開された回数
    };

    /// @brief コルーチンを生成する関数
    /// @return Taskオブジェクト
    Task gen_coroutine()
    {
        co_await std::suspend_always{};  // 最初のサスペンドポイント
        co_await std::suspend_always{};  // 2回目のサスペンドポイント
        co_return;                       // コルーチン終了
    }

以下単体テストコードによりに上記コルーチンの動作を示す。

    //  example/term_explanation_cpp20/co_await_ut.cpp 85

    Task    task  = gen_coroutine();  // gen_coroutine から Task オブジェクトを生成
    int32_t calls = 0;

    /// @test コルーチンを resume() で再開し、完了するまでループする
    while (task.resume()) {  // コルーチンが完了していない間、再開
        switch (calls) {
        case 0:
            /// @test コルーチンが1回目の再開後、"call 1" が返されることを確認
            ASSERT_EQ("call 1", task.get_value());
            break;
        case 1:
            /// @test コルーチンが2回目の再開後、"call 2" が返されることを確認
            ASSERT_EQ("call 2", task.get_value());
            break;
        case 2:
            /// @test コルーチンが3回目の再開後、"call 3" が返されることを確認
            ASSERT_EQ("call 3", task.get_value());
            break;
        }
        ++calls;
    }

    /// @test コルーチンが 2 回 resume された後に終了していることを確認
    ASSERT_EQ(2, calls);

上記のコルーチンと同じ機能を持つクラスのco_await/co_returnを使わない実装を以下に示す。

    //  example/term_explanation_cpp20/co_await_ut.cpp 115

    /// @enum CoroutineState
    /// @brief ManualCoroutine の状態を表す enum 型
    enum class CoroutineState {
        Start,             ///< コルーチンが開始された状態
        FirstSuspension,   ///< コルーチンが最初にサスペンドされた状態
        SecondSuspension,  ///< コルーチンが2回目にサスペンドされた状態
        Finished           ///< コルーチンが完了した状態
    };

    /// @brief コルーチンの状態を保持し、進行を管理するためのクラス
    class ManualCoroutine {
    public:
        /// @brief コルーチンの代わりに状態を進行させる関数
        /// @details コルーチンの状態に基づいて進行し、コルーチンのように振る舞う
        /// @return コルーチンが継続可能なら true、終了していれば false を返す
        bool resume()
        {
            ++called;  // コルーチンの再開回数をカウント
            switch (state) {
            case CoroutineState::Start:
                state = CoroutineState::FirstSuspension;
                return true;  // 継続可能

            case CoroutineState::FirstSuspension:
                state = CoroutineState::SecondSuspension;
                return true;  // 継続可能

            case CoroutineState::SecondSuspension:
                state = CoroutineState::Finished;
                return false;  // 終了

            case CoroutineState::Finished:
                return false;  // 既に終了している
            }
            assert(false);  // 不正な状態(理論的には到達しないはず)
            return false;
        }

        /// @brief 呼び出し回数に基づいた文字列を返す
        /// @return "call X" という形式の文字列(X は呼び出し回数)
        std::string get_value() { return "call " + std::to_string(called); }

    private:
        uint32_t       called = 0;                      ///< コルーチンが再開された回数
        CoroutineState state  = CoroutineState::Start;  ///< 現在のコルーチンの状態
    };

このクラスは当然ながら、前記のコルーチンの単体テストコードとほぼ同じになる。

    //  example/term_explanation_cpp20/co_await_ut.cpp 167

    auto    manual_coroutine = ManualCoroutine{};
    int32_t calls            = 0;

    while (manual_coroutine.resume()) {  // コルーチンを再開する
        switch (calls) {
        case 0:
            /// @test 1回目の再開後に "call 1" が返されることを確認
            ASSERT_EQ("call 1", manual_coroutine.get_value());
            break;
        case 1:
            /// @test 2回目の再開後に "call 2" が返されることを確認
            ASSERT_EQ("call 2", manual_coroutine.get_value());
            break;
        case 2:
            /// @test 3回目の再開後に "call 3" が返されることを確認
            ASSERT_EQ("call 3", manual_coroutine.get_value());
            break;
        }
        ++calls;  ///< コルーチンの再開回数をインクリメント
    }

    /// @test コルーチンが2回 resume された後に終了していることを確認
    ASSERT_EQ(2, calls);

C++20から導入されたco_await、co_return、TaskとC++17以前の機能のみを使用したコードの対比によって、 コルーチンのサポート機能により実装が容易になることが理解できるだろう。

co_return

co_returnはコルーチンの終了時に値を返すために使用される。 co_returnは通常co_awaitと同時に使われることが多い。

co_yield

co_yieldはコルーチンから値を返しつつ、 次の再開ポイントまで処理を中断する。これはジェネレーターの実装に便利である。

    //  example/term_explanation_cpp20/co_yield_ut.cpp 12

    template <typename T>
    class Generator {
    public:
        Generator(Generator&& other) noexcept : coro{std::move(other.coro)} { other.coro = nullptr; }

        Generator& operator=(Generator&& other) noexcept
        {
            if (this != &other) {
                coro       = other.coro;
                other.coro = nullptr;
            }
            return *this;
        }

        /// @struct promise_type
        /// @brief コルーチンのライフサイクルを管理する構造体
        struct promise_type {
            T current_value;

            /// @brief コルーチンから Generator 型のオブジェクトを返す関数
            /// @return Generatorオブジェクト
            Generator get_return_object() { return Generator{std::coroutine_handle<promise_type>::from_promise(*this)}; }

            /// @brief コルーチンの最初のサスペンドポイント
            /// @return 常にサスペンドするオブジェクトを返す
            std::suspend_always initial_suspend() { return {}; }

            /// @brief コルーチンの最後のサスペンドポイント
            /// @return 常にサスペンドするオブジェクトを返す
            std::suspend_always final_suspend() noexcept { return {}; }

            /// @brief コルーチンで値を生成するためのサスペンドポイント
            /// @param value 生成された値
            /// @return 常にサスペンドするオブジェクトを返す
            std::suspend_always yield_value(T value)
            {
                current_value = value;
                return {};
            }

            /// @brief コルーチン内で例外が発生した場合に呼び出される
            void unhandled_exception() { std::exit(1); }

            /// @brief コルーチンの終了時に呼び出される
            void return_void() {}
        };

        /// @brief コルーチンを再開し、次の値を生成する
        /// @return 次の値が生成された場合は true、終了した場合は false
        bool move_next()
        {
            if (coro && !coro.done()) {
                coro.resume();
                return !coro.done();
            }
            return false;
        }

        /// @brief 現在の値を取得する
        /// @return 現在の値
        T current_value() const { return coro.promise().current_value; }

        /// @brief Generator のコンストラクタ
        /// @param h コルーチンハンドル
        Generator(std::coroutine_handle<promise_type> h) : coro(h) {}

        /// @brief Generator のデストラクタ
        /// @details コルーチンハンドルが有効であれば破棄する
        ~Generator()
        {
            if (coro) coro.destroy();
        }

    private:
        std::coroutine_handle<promise_type> coro;
    };

    /// @brief 偶数のみをフィルタリングする
    /// @param input フィルタ対象の Generator
    /// @return フィルタ後の Generator
    Generator<int> filter_even(Generator<int> input)
    {
        while (input.move_next()) {
            if (input.current_value() % 2 == 0) {
                co_yield input.current_value();
            }
        }
    }

    /// @brief 値を2倍に変換する
    /// @param input 変換対象の Generator
    /// @return 変換後の Generator
    Generator<int> double_values(Generator<int> input)
    {
        while (input.move_next()) {
            co_yield input.current_value() * 2;
        }
    }

    /// @brief 数値の範囲を生成する
    /// @param start 開始値
    /// @param end 終了値
    /// @return 範囲内の数値を生成する Generator
    Generator<int> generate_numbers(int start, int end)
    {
        for (int i = start; i <= end; ++i) {
            co_yield i;
        }
    }

このテストを以下に示す。

    //  example/term_explanation_cpp20/co_yield_ut.cpp 127

    // 数値を生成し、それをパイプライン処理に通す
    auto numbers         = generate_numbers(1, 10);
    auto even_numbers    = filter_even(std::move(numbers));
    auto doubled_numbers = double_values(std::move(even_numbers));

    // 結果を検証するために期待される値の配列を準備
    std::vector<int> expected_values = {4, 8, 12, 16, 20};

    // 生成された値を順に取得し、期待される値と比較
    size_t index = 0;
    while (doubled_numbers.move_next()) {
        ASSERT_LT(index, expected_values.size());  // インデックスが範囲内か確認
        EXPECT_EQ(doubled_numbers.current_value(), expected_values[index]);
        ++index;
    }

    // 最終的にすべての期待される値が生成されたことを確認
    EXPECT_EQ(index, expected_values.size());

co_await、co_returnの例でみたように、 co_yieldを使用したコルーチンと同じ機能を持つクラスのco_yieldを使わない実装を以下に示す。

    //  example/term_explanation_cpp20/co_yield_ut.cpp 152

    /// @brief コルーチンを使わずにデータを逐次的に提供するジェネレータークラス
    template <typename T>
    class Generator {
    public:
        /// @brief コンストラクタ
        /// @param data 生成対象のデータ
        Generator(std::vector<T>&& data) : data_(std::move(data)), current_index_(0) {}

        /// @brief 次の値があるかを確認し、次の値に進む
        /// @return 次の値が存在する場合は true、存在しない場合は false
        bool move_next()
        {
            if (current_index_ < data_.size()) {
                ++current_index_;
                return true;
            }
            return false;
        }

        /// @brief 現在の値を取得する
        /// @return 現在の値
        T current_value() const
        {
            if (current_index_ > 0 && current_index_ <= data_.size()) {
                return data_[current_index_ - 1];
            }
            throw std::out_of_range("Invalid current value access");
        }

    private:
        std::vector<T> data_;           ///< データを保持
        size_t         current_index_;  ///< 現在のインデックス
    };

    /// @brief 偶数のみをフィルタリングする
    /// @param input フィルタ対象の Generator
    /// @return フィルタ後の Generator
    Generator<int> filter_even(const Generator<int>& input)
    {
        std::vector<int> filtered;
        auto             gen = input;

        while (gen.move_next()) {
            if (gen.current_value() % 2 == 0) {
                filtered.push_back(gen.current_value());
            }
        }
        return Generator<int>(std::move(filtered));
    }

    /// @brief 値を2倍に変換する
    /// @param input 変換対象の Generator
    /// @return 変換後の Generator
    Generator<int> double_values(const Generator<int>& input)
    {
        std::vector<int> doubled;
        auto             gen = input;

        while (gen.move_next()) {
            doubled.push_back(gen.current_value() * 2);
        }
        return Generator<int>(std::move(doubled));
    }

    /// @brief 数値の範囲を生成する
    /// @param start 開始値
    /// @param end 終了値
    /// @return 範囲内の数値を生成する Generator
    Generator<int> generate_numbers(int start, int end)
    {
        std::vector<int> numbers;
        for (int i = start; i <= end; ++i) {
            numbers.push_back(i);
        }
        return Generator<int>(std::move(numbers));
    }

このクラスは当然ながら、前記のコルーチンの単体テストコードとほぼ同じになる。

    //  example/term_explanation_cpp20/co_yield_ut.cpp 234

    // 数値を生成し、それをパイプライン処理に通す
    auto numbers         = generate_numbers(1, 10);
    auto even_numbers    = filter_even(std::move(numbers));
    auto doubled_numbers = double_values(std::move(even_numbers));

    // 結果を検証するために期待される値の配列を準備
    std::vector<int> expected_values = {4, 8, 12, 16, 20};

    // 生成された値を順に取得し、期待される値と比較
    size_t index = 0;
    while (doubled_numbers.move_next()) {
        ASSERT_LT(index, expected_values.size());  // インデックスが範囲内か確認
        EXPECT_EQ(doubled_numbers.current_value(), expected_values[index]);
        ++index;
    }

    // 最終的にすべての期待される値が生成されたことを確認
    EXPECT_EQ(index, expected_values.size());

C++20から導入されたco_await、co_return、TaskとC++17以前の機能のみを使用したコードの対比によって、 コルーチンのサポート機能により実装が容易になることが理解できるだろう。

モジュール

モジュールはC++20から導入された機能であり、以下の新しいキーワードによりサポートされる。

以下にこれらのキーワードのコード例を示す。

まずは、同時に使われることが多いmoduleexportの使用例を示す。

    //  example/module_cmake/type_traits.cppm 1

    export module type_traits;  // モジュール宣言

    namespace type_traits {  // 通常の名前空間。モジュール名と同じにして良い
    namespace Inner_ {       // 内部実装であるためexportしない

    // T == void
    template <typename T>
    constexpr auto is_void_sfinae_f_detector(void const* v, T const* t) noexcept
        -> decltype(t = v, bool{})  // T != voidの場合、t = vはill-formed
                                    // T == voidの場合、well-formedでbool型生成
    {
        return true;
    }

    // T != void
    template <typename T>
    constexpr auto is_void_sfinae_f_detector(void const*, T const*) noexcept
        -> decltype(sizeof(T), bool{})  // T != voidの場合、well-formedでbool型生成
                                        // T == voidの場合、sizeof(T)はill-formed
    {
        return false;
    }
    }  // namespace Inner_

    export
    {  // 纏めてexport
        template <typename T>
        constexpr bool is_void() noexcept
        {
            return Inner_::is_void_sfinae_f_detector(nullptr, static_cast<T*>(nullptr));
        }
        template <typename T>
        bool is_void_v = is_void<T>();
    }
    }  // namespace type_traits

最後にimportの使用例を示す。

    //  example/module_cmake/main.cpp 1

    import math;        // モジュールのインポート
    import type_traits; // モジュールのインポート

    #include <iostream>  // これまで同様のインクルード。stdのモジュール化はC++23から

    void f(int a, int b)
    {
        std::cout << "Add: " << math::add(a, b) << std::endl;
        std::cout << "Multiply: " << math::multiply(a, b) << std::endl;

        std::cout << std::boolalpha << type_traits::is_void<void>() << std::endl;
        std::cout << std::boolalpha << type_traits::is_void_v<decltype(a)> << std::endl;
    }

これらにより、モジュールは依存関係の管理、名前空間の分離、ビルド時間の短縮を実現し、 大規模プロジェクトでの保守性向上に貢献する。 が、一方ではC++のモジュールに対応してるビルドツールを使用することが望ましい。

ラムダ式

ラムダ式に関する言葉の定義と例を示す。

    //  example/term_explanation/lambda.cpp 10

    auto a = 0;

    // closureがクロージャ。それを初期化する式がラムダ式
    // [a = a]がキャプチャ
    // [a = a]内の右辺aは上記で定義されたa
    // [a = a]内の左辺aは右辺aで初期化された変数。ラムダ式内で使用されるaは左辺a。
    auto closure = [a = a](int32_t b) noexcept { return a + b; };

    auto ret = closure(3);  // クロージャの実行

    // g_closureはジェネリックラムダ
    auto g_closure = [](auto t0, auto t1) { return t0 + t1; };

    auto i = g_closure(1, 2);                                // t0、t1はint
    auto s = g_closure(std::string{"1"}, std::string{"2"});  // t0、t1はstd::string

クロージャ

ラムダ式」を参照せよ。

クロージャ型

ラムダ式」を参照せよ。

一時的ラムダ

一時的ラムダ(transient lambda)とは下記のような使い方をするラムダ式指す慣用用語である。

複雑な初期化を必要とするconstオブジェクトの生成をするような場合に有用なテクニックである。

    //  example/term_explanation/transient_lambda_ut.cpp 9

    std::vector<int> vec{1, 2, 3};

    // ラムダ式を即時実行するために () を追加
    auto const vec_act = [&vec = vec]() {
        using arg_type = std::remove_reference_t<decltype(vec)>;
        arg_type temp;
        for (auto val : vec) {
            temp.push_back(val * 2);
        }
        return temp;  // 変更後のベクターを返す
    }();

    std::vector<int> const vec_exp{2, 4, 6};

    ASSERT_EQ(vec_act, vec_exp);

transient lambda

一時的ラムダ」を参照せよ。

指示付き初期化

指示付き初期化(designated initialization)とは、C++20から導入されたシンタックスであり、 構造体やクラスのメンバを明示的に指定して初期化できるようにする機能である。 この構文により、コードの可読性と安全性が向上し、初期化漏れや順序の誤りを防ぐことができる。

まずは、この機能を有効に使えるクラス例を以下に示す。

    //  example/term_explanation_cpp20/designated_init_ut.cpp 11

    struct Point {
        int  x;
        int  y;
        bool operator==(Point const& rhs) const noexcept = default;
    };

    class Circl {
    public:
        Circl(Point center, uint32_t radius) : center_{center}, radius_{radius} {}

        std::string to_string()
        {
            std::ostringstream oss;

            oss << "center x:" << center_.x << " y:" << center_.y << " radius:" << radius_;
            return oss.str();
        }

        bool operator==(Circl const& rhs) const noexcept = default;

    private:
        Point const center_;
        uint32_t    radius_;
    };
    //  example/term_explanation_cpp20/designated_init_ut.cpp 41

    struct Point p0 {
        10, 20
    };
    struct Point p1 {
        .x = 10, .y = 20
    };  // x、yを明示できるため、可読性向上が見込める

    ASSERT_EQ(p0, p1);

    Circl circl_0{p1, 2U};
    ASSERT_EQ("center x:10 y:20 radius:2", circl_0.to_string());

    Circl circl_1{{10, 20}, 2U};  // circl_2に比べると可読性に劣る
    ASSERT_EQ("center x:10 y:20 radius:2", circl_1.to_string());

    Circl circl_2{{.x = 10, .y = 20}, 2U};  // x、yを明示できるため、可読性向上が見込める
    ASSERT_EQ("center x:10 y:20 radius:2", circl_2.to_string());

    ASSERT_EQ(circl_1, circl_2);

下記に示すように、Polymorphic Memory Resource(pmr)のpool_resourceの初期化には、 この機能を使うと可読性の改善が期待できる。

    //  example/term_explanation_cpp20/designated_init_ut.cpp 68

    std::pmr::unsynchronized_pool_resource pool_resource(
        std::pmr::pool_options{
            .max_blocks_per_chunk        = 10,   // チャンクあたりの最大ブロック数
            .largest_required_pool_block = 1024  // 最大ブロックサイズ
        },
        std::pmr::new_delete_resource()  // フォールバックリソース
    );

    std::pmr::vector<int> vec{&pool_resource};  // pmrを使用するベクタの定義

指示付き初期化を使わない以下のコード例と上記を比べれば可読性の改善に議論の余地はないだろう。

    //  example/term_explanation_cpp20/designated_init_ut.cpp 83

    // 指示付き初期化を使わずにstd::pmr::unsynchronized_pool_resourceの初期化
    std::pmr::unsynchronized_pool_resource pool_resource(
        std::pmr::pool_options{
            10,   // チャンクあたりの最大ブロック数
            1024  // 最大ブロックサイズ
        },
        std::pmr::new_delete_resource()  // フォールバックリソース
    );

    std::pmr::vector<int> vec{&pool_resource};  // pmrを使用するベクタの定義

プログラミング概念と標準ライブラリ

スマートポインタ

スマートポインタは、C++標準ライブラリが提供するメモリ管理クラス群を指す。 生のポインタの代わりに使用され、リソース管理を容易にし、 メモリリークや二重解放といった問題を防ぐことを目的としている。

スマートポインタは通常、所有権とスコープに基づいてメモリの解放を自動的に行う。 C++標準ライブラリでは、主に以下の3種類のスマートポインタが提供されている。

コンテナ

データを格納し、 効率的に操作するための汎用的なデータ構造を提供するC++標準ライブラリの下記のようなクラス群である。

シーケンスコンテナ(Sequence Containers)

データが挿入順に保持され、順序が重要な場合に使用する。

コンテナ 説明
std::vector 動的な配列で、ランダムアクセスが高速。末尾への挿入/削除が効率的
std::deque 両端に効率的な挿入/削除が可能な動的配列
std::list 双方向リスト。要素の順序を維持し、中間の挿入/削除が効率的
std::forward_list 単方向リスト。軽量だが、双方向の操作はできない
std::array 固定長配列で、サイズがコンパイル時に決まる
std::string 可変長の文字列を管理するクラス(厳密にはstd::basic_stringの特殊化)
std::forward_list
    //  example/term_explanation/cotainer_ut.cpp 14

    std::forward_list<int> fl{1, 2, 3};

    // 要素の挿入
    EXPECT_EQ(fl.front(), 1);
    fl.push_front(0);
    EXPECT_EQ(fl.front(), 0);

    auto it = fl.begin();
    EXPECT_EQ(*++it, 1);
    EXPECT_EQ(*++it, 2);
    EXPECT_EQ(*++it, 3);

連想コンテナ(Associative Containers)

データがキーに基づいて自動的にソートされ、検索が高速である。

コンテナ 説明
std::set 要素がソートされ、重複が許されない集合
std::multiset ソートされるが、重複が許される集合
std::map ソートされたキーと値のペアを保持。キーは一意
std::multimap ソートされたキーと値のペアを保持。キーは重複可能

無順序連想コンテナ(Unordered Associative Containers)

ハッシュテーブルを基盤としたコンテナで、順序を保証しないが高速な検索を提供する。

コンテナ 説明
std::unordered_set ハッシュテーブルベースの集合。重複は許されない
std::unordered_multiset ハッシュテーブルベースの集合。重複が許される
std::unordered_map ハッシュテーブルベースのキーと値のペア。キーは一意
std::unordered_multimap ハッシュテーブルベースのキーと値のペア。キーは重複可能
std::type_index 型情報型を連想コンテナのキーとして使用するためのクラス
std::unordered_set
    //  example/term_explanation/cotainer_ut.cpp 32

    std::unordered_set<int> uset{1, 2, 3};

    // 要素の挿入
    uset.insert(4);
    uset.insert(5);

    // 存在確認
    EXPECT_NE(uset.find(1), uset.end());
    EXPECT_NE(uset.find(4), uset.end());
    EXPECT_EQ(uset.find(6), uset.end());

    // サイズの確認
    EXPECT_EQ(uset.size(), 5);
std::unordered_map
    //  example/term_explanation/cotainer_ut.cpp 52

    std::unordered_map<int, std::string> umap;

    // 要素の挿入
    umap[1] = "one";
    umap[2] = "two";
    umap[3] = "three";

    // 要素の確認
    EXPECT_EQ(umap[1], "one");
    EXPECT_EQ(umap[2], "two");
    EXPECT_EQ(umap[3], "three");

    // 存在確認
    EXPECT_NE(umap.find(1), umap.end());
    EXPECT_EQ(umap.find(4), umap.end());
std::type_index

std::type_indexはコンテナではないが、 型情報型を連想コンテナのキーとして使用するためのクラスであるため、この場所に掲載する。

    //  example/term_explanation/cotainer_ut.cpp 74

    std::unordered_map<std::type_index, std::string> type_map;

    // std::type_indexを使って型をキーとしてマッピング
    type_map[typeid(int)]         = "int";
    type_map[typeid(double)]      = "double";
    type_map[typeid(std::string)] = "string";

    // マッピングの確認
    EXPECT_EQ(type_map[typeid(int)], "int");
    EXPECT_EQ(type_map[typeid(double)], "double");
    EXPECT_EQ(type_map[typeid(std::string)], "string");

    // 存在しない型の確認
    EXPECT_EQ(type_map.find(typeid(float)), type_map.end());

コンテナアダプタ(Container Adapters)

特定の操作のみを公開するためのラッパーコンテナ。

コンテナ 説明
std::stack LIFO(後入れ先出し)操作を提供するアダプタ
std::queue FIFO(先入れ先出し)操作を提供するアダプタ
std::priority_queue 優先度に基づく操作を提供するアダプタ

特殊なコンテナ

上記したようなコンテナとは一線を画すが、特定の用途や目的のために設計された一種のコンテナ。

コンテナ 説明
std::span 生ポインタや配列を抽象化し、安全に操作するための軽量ビュー
std::bitset 固定長のビット集合を管理するクラス
std::basic_string カスタム文字型をサポートする文字列コンテナ

std::optional

C++17から導入されたstd::optionalには、以下のような2つの用途がある。 以下の用途2から、 このクラスがオブジェクトのダイナミックなメモリアロケーションを行うような印象を受けるが、 そのようなことは行わない。 このクラスがオブジェクトのダイナミックな生成が必要になった場合、プレースメントnewを実行する。 ただし、std::optionalが保持する型自身がnewを実行する場合は、この限りではない。

  1. 関数の任意の型の戻り値の無効表現を持たせる
  2. オブジェクトの遅延初期化する(初期化処理が重く、 条件によってはそれが無駄になる場合にこの機能を使う)

戻り値の無効表現

    //  example/term_explanation/optional_ut.cpp 11

    /// @brief 指定されたファイル名から拡張子を取得する。
    /// @param filename ファイル名(パスを含む場合も可)
    /// @return 拡張子を文字列として返す。拡張子がない場合は std::nullopt を返す。
    std::optional<std::string> file_extension(std::string const& filename)
    {
        size_t pos = filename.rfind('.');
        if (pos == std::string::npos || pos == filename.length() - 1) {
            return std::nullopt;  // 値が存在しない
        }
        return filename.substr(pos + 1);
    }
    //  example/term_explanation/optional_ut.cpp 28

    auto ret0 = file_extension("xxx.yyy");

    ASSERT_TRUE(ret0);  // 値を保持している
    ASSERT_EQ("yyy", *ret0);

    auto ret1 = file_extension("xxx");

    ASSERT_FALSE(ret1);  // 値を保持していない
    // ASSERT_THROW(*ret1, std::exception);  // 未定義動作(エクセプションは発生しない)
    ASSERT_THROW(ret1.value(), std::bad_optional_access);  // 値非保持の場合、エクセプション発生

オブジェクトの遅延初期化

    //  example/term_explanation/optional_ut.cpp 43

    class HeavyResource {
    public:
        HeavyResource() : large_erea_{0xdeadbeaf}
        {  // large_erea_[0]を44にする
            initialied = true;
        }
        bool     is_ready() const noexcept { return large_erea_[0] == 0xdeadbeaf; }
        uint32_t operator[](size_t index) const noexcept { return large_erea_[index]; }

        static bool initialied;

    private:
        uint32_t large_erea_[1024];
    };
    bool HeavyResource::initialied;
    //  example/term_explanation/optional_ut.cpp 64

    std::optional<HeavyResource> resource;

    // resourceの内部のHeavyResourceは未初期化
    ASSERT_FALSE(resource.has_value());
    ASSERT_FALSE(HeavyResource::initialied);
    ASSERT_NE(0xdeadbeaf, (*resource)[0]);  // 未定義動作

    // resourceの内部のHeavyResourceの遅延初期化
    resource.emplace();  // std::optionalの内部でplacement newが実行される

    // ここから下は定義動作
    ASSERT_TRUE(HeavyResource::initialied);  // resourceの内部のHeavyResourceは初期化済み
    ASSERT_TRUE(resource.has_value());

    ASSERT_TRUE(resource->is_ready());
    ASSERT_EQ(0xdeadbeaf, (*resource)[0]);

std::variant

std::variantは、C++17で導入された型安全なunionである。 このクラスは複数の型のうち1つの値を保持することができ、 従来のunionに伴う低レベルな操作の安全性の問題を解消するために設計された。

std::variant自身では、オブジェクトのダイナミックな生成が必要な場合でも通常のnewを実行せず、 代わりにプレースメントnewを用いる (以下のコード例のようにstd::variantが保持する型自身がnewを実行する場合は、この限りではない)。

以下にstd::variantの典型的な使用例を示す。

    //  example/term_explanation/variant_ut.cpp 13

    std::variant<int, std::string, double> var  = 10;
    auto                                   var2 = var;  // コピーコンストラクタの呼び出し

    ASSERT_EQ(std::get<int>(var), 10);  // 型intの値を取り出す

    // 型std::stringの値を取り出すが、その値は持っていないのでエクセプション発生
    ASSERT_THROW(std::get<std::string>(var), std::bad_variant_access);

    var = "variant";  // "variant"はstd::stringに変更され、varにムーブされる
    ASSERT_EQ(std::get<std::string>(var), "variant");

    ASSERT_NE(var, var2);  // 保持している値の型が違う

    var2.emplace<std::string>("variant");  // "variant"からvar2の値を直接生成するため、
                                           // 文字列代入より若干効率的
    ASSERT_EQ(var, var2);

    var = 1.0;
    ASSERT_FLOAT_EQ(std::get<2>(var), 1.0);  // 2番目の型の値を取得

std::variantとstd::visit(Visitorパターンの実装の一種)を組み合わせた場合の使用例を以下に示す。

    //  example/term_explanation/variant_ut.cpp 37

    void output_from_variant(std::variant<int, double, std::string> const& var, std::ostringstream& oss)
    {
        std::visit([&oss](auto&& arg) { oss.str().empty() ? oss << arg : oss << "|" << arg; }, var);
    }
    //  example/term_explanation/variant_ut.cpp 47

    std::ostringstream                     oss;
    std::variant<int, double, std::string> var = 42;

    output_from_variant(var, oss);
    ASSERT_EQ("42", oss.str());

    var = 3.14;
    output_from_variant(var, oss);
    ASSERT_EQ("42|3.14", oss.str());

    var = "Hello, world!";
    output_from_variant(var, oss);
    ASSERT_EQ("42|3.14|Hello, world!", oss.str());

name lookupと名前空間

ここではname lookupとそれに影響を与える名前空間について解説する。

ルックアップ

このドキュメントでのルックアップとはname lookupを指す。

name lookup

name lookup とはソースコードで名前が検出された時に、その名前をその宣言と関連付けることである。 以下、name lookupの例を上げる。

下記のようなコードがあった場合、

    //  example/term_explanation/name_lookup_ut.cpp 5

    namespace NS_LU {
    int f() noexcept { return 0; }
    }  // namespace NS_LU

以下のコードでの関数呼び出しf()のname lookupは、

    //  example/term_explanation/name_lookup_ut.cpp 29

    NS_LU::f();
  1. NS_LUをその前方で宣言された名前空間と関連付けする
  2. f()呼び出しをその前方の名前空間NS_LUで宣言された関数fと関連付ける

という手順で行われる。

下記のようなコードがあった場合、

    //  example/term_explanation/name_lookup_ut.cpp 11

    namespace NS_LU {
    bool g(int i) noexcept { return i < 0; }

    char g(std::string_view str) noexcept { return str[0]; }

    template <typename T, size_t N>
    size_t g(T const (&)[N]) noexcept
    {
        return N;
    }

以下のコードでの関数呼び出しg()のname lookupは、

    //  example/term_explanation/name_lookup_ut.cpp 37
    int a[3]{1, 2, 3};
    NS_LU::g(a);
  1. NS_LUをその前方で宣言された名前空間と関連付けする
  2. 名前空間NS_LU内で宣言された複数のgを見つける
  3. g()呼び出しを、 すでに見つけたgの中からベストマッチしたg(T const (&)[N])と関連付ける

という手順で行われる。

下記記のようなコードがあった場合、

    //  example/term_explanation/name_lookup_ut.cpp 44

    // グローバル名前空間
    std::string ToString(int i) { return std::to_string(i) + " in Global"; }

    namespace NS_LU {
    struct X {
        int i;
    };

    std::string ToString(X const& x) { return std::to_string(x.i) + " in NS_LU"; }
    }  // namespace NS_LU

    namespace NS2 {
    std::string ToString(NS_LU::X const& x) { return std::to_string(x.i) + " in NS2"; }
    }  // namespace NS2

以下のコードでの関数呼び出しToString()のname lookupは、

    //  example/term_explanation/name_lookup_ut.cpp 65

    auto x = NS_LU::X{1};

    ASSERT_EQ("1 in NS_LU", ToString(x));
  1. ToString()呼び出しの引数xの型Xが名前空間NS_LUで定義されているため、 ToStringを探索する名前空間にNS_LUを組み入れる(「関連名前空間」参照)
  2. ToString()呼び出しより前方で宣言されたグローバル名前空間とNS_LUの中から、 複数のToStringの定義を見つける
  3. ToString()呼び出しを、 すでに見つけたToStringの中からベストマッチしたNS_LU::ToStringと関連付ける

という手順で行われる。

two phase name lookup

two phase name lookup とはテンプレートをインスタンス化するときに使用される、下記のような2段階でのname lookupである。

  1. テンプレート定義内でname lookupを行う(通常のname lookupと同じ)。 この時、テンプレートパラメータに依存した名前 (dependent_name)は name lookupの対象外となる(name lookupの対象が確定しないため)。
  2. 1の後、テンプレートパラメータを展開した関数内で、 関連名前空間の宣言も含めたname lookupを行う。

以下の議論では、

と呼ぶことにする。

下記のようなコードがあった場合、

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 5

    namespace NS_TPLU {
    struct X {
        int i;
    };
    }  // namespace NS_TPLU

    // グローバル名前空間
    inline std::string ToType(NS_TPLU::X const&) { return "X in global"; }
    inline std::string ToType(int const&) { return "int in global"; }

    // 再びNS_TPLU
    namespace NS_TPLU {

    std::string Header(long) { return "type:"; }  //  下記にもオーバーロードあり

    template <typename T>
    std::string ToType(T const&)  //  下記にもオーバーロードあり
    {
        return "unknown";
    }

    template <typename T>
    std::string TypeName(T const& t)  // オーバーロードなし
    {
        return Header(int{}) + ToType(t);
    }

    std::string Header(int) { return "TYPE:"; }  // 上記にもオーバーロードあり

    std::string ToType(X const&) { return "X"; }      // 上記にもオーバーロードあり
    std::string ToType(int const&) { return "int"; }  // 上記にもオーバーロードあり
    }  // namespace NS_TPLU

以下のコードでのTypeNameのインスタンス化に伴うname lookupは、

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 44

    auto x = NS_TPLU::X{1};

    ASSERT_EQ("type:X", TypeName(x));
  1. TypeName()呼び出しの引数xの型Xが名前空間NS_TPLUで宣言されているため、 NS_TPLUをTypeNameを探索する関連名前空間にする。
  2. TypeName()呼び出しより前方で宣言されたグローバル名前空間とNS_TPLUの中からTypeNameを見つける。
  3. TypeNameは関数テンプレートであるためtwo phase lookupが以下のように行われる。
    1. TypeName内でのHeader(int{})の呼び出しは、1st name lookupにより、 Header(long)の宣言と関連付けられる。 Header(int)はHeader(long)よりもマッチ率が高い、 TypeNameの定義より後方で宣言されているため、name lookupの対象外となる。
    2. TypeName内でのToType(t)の呼び出しに対しては、2nd name lookupが行われる。 このためTypeName定義より前方で宣言されたグローバル名前空間と、 tの型がNS_TPLU::Xであるため関連名前空間となったNS_TPLUがname lookupの対象となるが、 グローバル名前空間内のToTypeは、 NS_TPLU内でTypeNameより前に宣言されたtemplate<> ToTypeによってname-hidingが起こり、 TypeNameからは非可視となるためname lookupの対象から外れる。 このため、ToType(t)の呼び出しは、NS_TPLU::ToType(X const&)の宣言と関連付けられる。

という手順で行われる。

上と同じ定義、宣言がある場合の以下のコードでのTypeNameのインスタンス化に伴うname lookupは、

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 50

    ASSERT_EQ("type:unknown", NS_TPLU::TypeName(int{}));
  1. NS_TPLUを名前空間と関連付けする (引数の型がintなのでNS_TPLUは関連名前空間とならず、NS_TPLUを明示する必要がある)。
  2. TypeName()呼び出しより前方で宣言されたNS_TPLUの中からTypeNameを見つける。
  3. TypeNameは関数テンプレートであるためtwo phase lookupが以下のように行われる。
    1. TypeName内でのHeader(int{})の呼び出しは、1st name lookupにより、 前例と同じ理由で、Header(long)の宣言と関連付けられる。
    2. TypeName内でのToType(t)の呼び出しに対しては、2nd name lookupが行われる。 tの型がintであるためNS_TPLUは関連名前空間とならず、通常のname lookupと同様に ToType(t)の呼び出し前方のグローバル名前空間とNS_TPLUがname lookupの対象になるが、 グローバル名前空間内のToTypeは、 NS_TPLU内でTypeNameより前に宣言されたtemplate<> ToTypeによってname-hidingが起こり、 TypeNameからは非可視となるためname lookupの対象から外れる。 また、ToType(int const&)は、TypeNameの定義より後方で宣言されているため、 name lookupの対象外となり、 その結果、ToType(t)の呼び出しは、NS_TPLU内のtemplate<> ToTypeの宣言と関連付けられる。

という手順で行われる。

以上の理由から、先に示した例でのToTypeの戻り値は”X”となり、 後に示した例でのToTypeの戻り値は”unknown”となる。 これはtwo phase lookupの結果であり、 two phase lookupが実装されていないコンパイラ(こういったコンパイラは存在する)では、 結果が異なるため注意が必要である (本ドキュメントではこのような問題をできる限り避けるために、 サンプルコードをg++clang++でコンパイルしている)。

以下に、two phase lookupにまつわるさらに驚くべきコード例を紹介する。 上と同じ定義、宣言がある場合の以下のコードの動作を考える。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 54

    ASSERT_EQ("type:long", NS_TPLU::TypeName(long{}));

NS_TPLU::TypeName(int{})のintをlongにしただけなので、この単体テストはパスしないが、 この単体テストコードの後(実際にはこのファイルのコンパイル単位の中のNS_TPLU内で、 且つtemplate<> ToTypeの宣言の後方であればどこでもよい) に以下のコードを追加するとパスしてしまう。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 61

    namespace NS_TPLU {
    template <>
    std::string ToType<long>(long const&)
    {
        return "long";
    }
    }  // namespace NS_TPLU

この理由は、関数テンプレート内での2nd name lookupで選択された名前が関数テンプレートであった場合、 その特殊化の検索範囲はコンパイル単位内になることがあるからである (template_specialization によるとこの動作は未定義のようだが、 g++/clang++両方ともこのコードを警告なしでコンパイルする)。

TypeName(long{})内でのtwo phase name lookupは、TypeName(int{})とほぼ同様に進み、 template<> ToTypeの宣言を探し出すが、 さらに前述したようにこのコンパイル単位のNS_TPLU内からその特殊化も探し出す。 その結果、ToType(t)の呼び出しは、NS_TPLU内のtemplate<> ToType<long>の定義と関連付けられる。

以上の議論からわかる通り、関数テンプレートとその特殊化の組み合わせは、 そのインスタンス化箇所(この場合単体テストコード内)の後方から、 name lookupでバインドされる関数を変更することができるため、 極めて分かりづらいコードを生み出す。ここから、

という教訓が得られる。

なお、関数とその関数オーバーロードのname lookupの対象は、呼び出し箇所前方の宣言のみであるため、 関数テンプレートToType(T const& t)の代わりに、関数ToType(…)を使うことで、 上記問題は回避可能である。

次に示す例は、一見2nd name lookupで関連付けされるように見える関数ToType(NS_TPLU2::Y const&)が、 実際には関連付けされないコードである。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 71

    namespace NS_TPLU2 {
    struct Y {
        int i;
    };
    }  // namespace NS_TPLU2
    //  example/term_explanation/two_phase_name_lookup_ut.cpp 79

    // global名前空間
    template <typename T>
    std::string ToType(T const&)
    {
        return "unknown";
    }

    template <typename T>
    std::string TypeName(T const& t)
    {
        return "type:" + ToType(t);
    }

    std::string ToType(NS_TPLU2::Y const&) { return "Y"; }

これは先に示したNS_TPLU::Xの例と極めて似ている。本質的な違いは、 TypeNameやToTypeがグローバル名前空間で宣言されていることのみである。 だが、下記の単体テストで示す通り、 TypeName内でのname lookupで関数オーバーライドToType(NS_TPLU2::Y const&)が選択されないのである。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 100

    auto y = NS_TPLU2::Y{1};

    // ASSERT_EQ("type:Y", TypeName(y));
    ASSERT_EQ("type:unknown", TypeName(y));  // ToType(NS_TPLU2::Y const&)は使われない

ここまでの現象を正確に理解するには、 「two phase lookupの対象となる宣言」を下記のように、より厳密に認識する必要がある。

この認識に基づくNS_TPLU2::Yに対するグローバルなTypeName内でのtwo phase name lookupは、

  1. TypeName内に1st name lookupの対象がないため何もしない。
  2. TypeName内の2nd name lookupに使用される関連名前空間NS_TPLU2は、 ToType(NS_TPLU2::Y const&)の宣言を含まないため、この宣言は2nd name lookupの対象とならない。 その結果、ToType(t)の呼び出しは関数テンプレートToType(T const&)と関連付けられる。

という手順で行われる。

以上が、TypeNameからToType(NS_TPLU2::Y const&)が使われない理由である。

ここまでで示したようにtwo phase name lookupは理解しがたく、 理解したとしてもその使いこなしはさらに難しい。

次のコードは、この難解さに翻弄されるのが現場のプログラマのみではないことを示す。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 71

    namespace NS_TPLU2 {
    struct Y {
        int i;
    };
    }  // namespace NS_TPLU2
    //  example/term_explanation/two_phase_name_lookup_ut.cpp 110

    // global名前空間
    template <typename T>
    int operator+(T const&, int i)
    {
        return i;
    }

    template <typename T>
    int TypeNum(T const& t)
    {
        return t + 0;
    }

    int operator+(NS_TPLU2::Y const& y, int i) { return y.i + i; }

上記の宣言、定義があった場合、operator+の単体テストは以下のようになる。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 132

    auto y = NS_TPLU2::Y{1};

    ASSERT_EQ(1, y + 0);  // 2つ目のoperator+が選択される

このテストは当然パスするが、次はどうだろう?

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 142

    auto y = NS_TPLU2::Y{1};

    ASSERT_EQ(1, TypeNum(y));  // g++ではoperator+(NS_TPLU2::Y const&, int i)がname lookupされる

これまでのtwo phase name lookupの説明では、 operator+(NS_TPLU2::Y const& y, int i)はTypeNum内でのname lookupの対象にはならないため、 このテストはエラーとならなければならないが、g++ではパスしてしまう。 2nd name lookupのロジックにバグがあるようである。

有難いことに、clang++では仕様通りこのテストはエラーとなり、 当然ながら以下のテストはパスする(つまり、g++ではエラーする)。

    //  example/term_explanation/two_phase_name_lookup_ut.cpp 151

    auto y = NS_TPLU2::Y{1};

    ASSERT_EQ(0, TypeNum(y));  // clang++ではoperator+(T const&, int i)がname lookupされる

なお、TypeNum内のコードである

    return t + 0;

を下記のように変更することで

    return operator+(t, 0);

g++のname lookupはclang++と同じように動作するため、 記法に違和感があるものの、この方法はg++のバグのワークアランドとして使用できる。

また、operator+(NS_TPLU2::Y const& y, int i)をNS_TPLU2で宣言することで、 g++ではパスしたテストをclang++でもパスさせられるようになる(これは正しい動作)。 これにより、型とその2項演算子オーバーロードは同じ名前空間で宣言するべきである、 という教訓が得られる。

以上で見てきたようにtwo phase name lookupは、現場プログラマのみではなく、 コンパイラを開発するプログラマをも混乱させるほど難解ではあるが、 STLを含むテンプレートメタプログラミングを支える重要な機能であるため、 C++プログラマには、最低でもこれを理解し、出来れば使いこなせるようになってほしい。

実引数依存探索

実引数依存探索とは、argument-dependent lookupの和訳語であり、 通常はその略語であるADLと呼ばれる。

ADL

ADLとは、関数の実引数の型が宣言されている名前空間(これを関連名前空間と呼ぶ)内の宣言が、 その関数のname lookupの対象になることである。

下記のようなコードがあった場合、

    //  example/term_explanation/name_lookup_adl_ut.cpp 5
    namespace NS_ADL {
    struct A {
        int i;
    };

    std::string ToString(A const& a) { return std::string{"A:"} + std::to_string(a.i); }
    }  // namespace NS_ADL

以下のコードでのToStringの呼び出しに対するのname lookupは、

    //  example/term_explanation/name_lookup_adl_ut.cpp 18

    auto a = NS_ADL::A{0};

    ASSERT_EQ("A:0", ToString(a));  // ADLの効果により、ToStringはNS_ADLを指定しなくても見つかる

の両方を対象として行われる。 NS_ADL内の宣言がToStringの呼び出しに対するのname lookupの対象になる理由は、 ToStringの呼び出しに使われている実引数aの型AがNS_ADLで宣言されているからである。 すでに述べたようにこれをADLと呼び、この場合のNS_ADLを関連名前空間と呼ぶ。

ADLは思わぬname lookupによるバグを誘発することもあるが、 下記コードを見れば明らかなように、また、 多くのプログラマはそれと気づかずに使っていることからもわかる通り、 コードをより自然に、より簡潔に記述するための重要な機能となっている。

    //  example/term_explanation/name_lookup_adl_ut.cpp 28

    // 下記operator <<は、std::operator<<(ostream&, string const&)であり、
    // namespace stdで定義されている。

    // ADLがあるため、operator <<は名前空間修飾無しで呼び出せる。
    std::cout << std::string{__func__};

    // ADLが無いと下記のような呼び出しになる。
    std::operator<<(std::cout, std::string{__func__});

関連名前空間

関連名前空間(associated namespace)とは、 ADL(実引数依存探索)によってname lookupの対象になった宣言を含む名前空間のことである。

修飾付き関数呼び出し

修飾付き関数呼び出し(Qualified Call)は、 C++で関数やメンバ関数を明示的にスコープやクラス名で修飾して呼び出す方法である。 名前の曖昧性を回避し、特定の関数やクラスメンバを明確に選択する際に利用される。 これにより、意図しないname lookupを回避することができるため、可読性と安全性が向上する。 一方で、ADLが働かなくなるため、フレキシブルなname lookupができなくなる。

    //  example/term_explanation/etc_ut.cpp 64

    extern void func();  // グローバル名前空間での宣言

    struct Base {
        void func() const noexcept {}
    };

    A::func();  // 名前空間名による修飾

    struct Derived : Base {
        // void        func() { func(); /* funcの無限リカーシブコール */ }
        void        func() { Base::func(); /* クラス名での修飾 */ }
        void        func(int) { ::func(); /* グローバル修飾 */ }
        void        func(Base) { this->func(); /* thisによる修飾 */ }
        static void func(std::string) {}
    };

    Base b;
    b.func();        // 通常の関数呼び出し
    b.Base::func();  // クラス名での修飾による関数呼び出し

    Derived d;
    Derived::func("str");  // クラス名での修飾による関数呼び出し
    d.func("str");         // 通常の関数呼び出し

hidden-friend関数

hidden-friend関数(隠れたフレンド関数、あるいは単にhidden-friend)とは、

friend関数のことを指す。このような性質から、non-namespace-visible friend関数と呼ばれることもある。

これにより、意図的に外部からのアクセスを制限し、 必要な場合にのみ利用されることを保証する設計が可能となる。

hidden-friend関数(隠れたフレンド関数)の目的は、

    //  example/term_explanation/hidden_friend_ut.cpp 7

    namespace NS {
    class Person {
    public:
        Person(std::string name, uint32_t age) : name_{std::move(name)}, age_{age} {}

        // hidden-friend関数
        friend std::ostream& operator<<(std::ostream& os, const Person& person)
        {
            os << "Name:" << person.name_ << ", Age:" << person.age_;
            return os;
        }

    private:
        std::string const name_;
        uint32_t const    age_;
    };
    }  // namespace NS
    //  example/term_explanation/hidden_friend_ut.cpp 31

    NS::Person         alice("Alice", 30);
    std::ostringstream oss;

    oss << alice;  // フレンド関数を呼び出す(ADLによって見つかる)
    ASSERT_EQ("Name:Alice, Age:30", oss.str());

    // 以下はエラー(operator<<がNS名前空間スコープで見えない)
    // NS::Person::operator<<(oss, alice);
    // 上記は以下のようなコンパイルエラーになる
    //  error: ‘operator<<’ is not a member of ‘NS::Person’

name-hiding

name-hidingとは 「前方の識別子が、その後方に同一の名前をもつ識別子があるために、 name lookupの対象外になる」現象一般を指す通称である (namespace参照)。

まずは、クラスとその派生クラスでのname-hidingの例を示す。

    //  example/term_explanation/name_hiding.cpp 4

    struct Base {
        void f() noexcept {}
    };

    struct Derived : Base {
        // void f(int) { f(); }     // f()では、Baseのf()をname lookupできないため、
        void f(int) noexcept { Base::f(); }  // Base::でf()を修飾した
    };

上記の関数fは一見オーバーロードに見えるが、そうではない。下記のコードで示したように、 Base::f()には、修飾しない形式でのDerivedクラス経由のアクセスはできない。

    //  example/term_explanation/name_hiding.cpp 18

    {
        auto d = Derived{};
    #if 0 
        d.f(); // コンパイルできない
    #else
        d.Base::f();  // Base::での修飾が必要
    #endif
    }

これは前述したように、 Base::fがその後方にあるDerived::f(int)によりname-hidingされたために起こる現象である (name lookupによる探索には識別子が使われるため、シグネチャの違いはname-hidingに影響しない)。

下記のようにusing宣言を使用することで、 修飾しない形式でのDerivedクラス経由のBase::f()へのアクセスが可能となる。

    //  example/term_explanation/name_hiding.cpp 34

    struct Derived : Base {
        using Base::f;  // using宣言によりDerivedにBase::fを導入
        void f(int) noexcept { Base::f(); }
    };
    //  example/term_explanation/name_hiding.cpp 45

    auto d = Derived{};
    d.f();  // using宣言によりコンパイルできる

下記コードは、名前空間でも似たような現象が起こることを示している。

    //  example/term_explanation/name_hiding.cpp 54

    // global名前空間
    void f() noexcept {}

    namespace NS_A {
    void f(int) noexcept {}

    void g() noexcept
    {
    #if 0
        f();  // NS_A::fによりname-hidingされたため、コンパイルできない
    #endif
    }
    }  // namespace NS_A

この問題に対しては、下記のようにf(int)の定義位置を後方に移動することで回避できる。

    //  example/term_explanation/name_hiding.cpp 70

    namespace NS_A_fixed_0 {
    void g() noexcept
    {
        // グローバルなfの呼び出し
        f();  // NS_A::fは後方に移動されたためコンパイルできる
    }

    void f(int) noexcept {}
    }  // namespace NS_A_fixed_0

また、先述のクラスでの方法と同様にusing宣言を使い、下記のようにすることもできる。

    //  example/term_explanation/name_hiding.cpp 82

    namespace NS_A_fixed_1 {
    void f(int) noexcept {}

    void g() noexcept
    {
        using ::f;

        // グローバルなfの呼び出し
        f();  // using宣言によりコンパイルできる
    }
    }  // namespace NS_A_fixed_1

当然ながら、下記のようにf()の呼び出しを::で修飾することもできる。

    //  example/term_explanation/name_hiding.cpp 96

    namespace NS_A_fixed_2 {
    void f(int) noexcept {}

    void g() noexcept
    {
        // グローバルなfの呼び出し
        ::f();  // ::で修飾すればコンパイルできる
    }
    }  // namespace NS_A_fixed_2

修飾の副作用として「two phase name lookup」の例で示したような ADLを利用した高度な静的ディスパッチが使用できなくなるが、 通常のソフトウェア開発では、ADLが必要な場面は限られているため、 デフォルトでは名前空間を使用して修飾を行うことにするのが、 無用の混乱をさけるための安全な記法であると言えるだろう。

次に、そういった混乱を引き起こすであろうコードを示す。

    //  example/term_explanation/name_hiding.cpp 108

    namespace NS_B {
    struct S_in_B {};

    void f(S_in_B) noexcept {}
    void f(int) noexcept {}

    namespace NS_B_Inner {
    void g() noexcept
    {
        f(int{});  // コンパイルでき、NS_B::f(int)が呼ばれる
    }

    void f() noexcept {}

    void h() noexcept
    {
        // f(int{});     // コンパイルできない
        NS_B::f(int{});  // 名前空間で修飾することでコンパイルできる

        f(S_in_B{});  // ADLによりコンパイルできる
    }
    }  // namespace NS_B_Inner
    }  // namespace NS_B

NS_B_Inner::g()内のf(int)の呼び出しはコンパイルできるが、 name-hidingが原因で、NS_B_Inner::h()内のf(int)の呼び出しはコンパイルできず、 名前空間で修飾することが必要になる。 一方で、ADLの効果で名前空間での修飾をしていないf(S_in_B)の呼び出しはコンパイルできる。

全チームメンバがこういったname lookupを正しく扱えると確信できないのであれば、 前述の通り、デフォルトでは名前空間を使用して修飾を行うのが良いだろう。

ダイヤモンド継承

ダイヤモンド継承(Diamond Inheritance)とは、以下のような構造のクラス継承を指す。

この継承は、多重継承の一形態であり、クラス図で表すと下記のようになるため、 ダイヤモンド継承と呼ばれる。

ダイヤモンド継承は、 仮想継承(virtual inheritance)を使ったものと、使わないものに分類できる。

仮想継承を使わないダイヤモンド継承のコードを以下に示す。

    //  example/term_explanation/diamond_inheritance_ut.cpp 6

    class Base {
    public:
        int32_t get() const noexcept { return x_; }
        void    set(int32_t x) noexcept { x_ = x; }

    private:
        int32_t x_ = 0;
    };

    class Derived_0 : public Base {};

    class Derived_1 : public Base {};

    class DerivedDerived : public Derived_0, public Derived_1 {};
    //  example/term_explanation/diamond_inheritance_ut.cpp 26

    auto dd = DerivedDerived{};

    Base& b0 = static_cast<Derived_0&>(dd);  // Derived_0::Baseのリファレンス
    Base& b1 = static_cast<Derived_1&>(dd);  // Derived_1::Baseのリファレンス

    ASSERT_NE(&b0, &b1);  // ddの中には、Baseインスタンスが2つできる

これからわかるように、DerivedDerivedインスタンスの中に2つのBaseインスタンスが存在する。 この状態をオブジェクト図で表すと下記のようになる。

下記コードは、それが原因で名前解決が曖昧になりコンパイルできない。

    //  example/term_explanation/diamond_inheritance_ut.cpp 36

    Base& b = dd;  // Derived_0::Base or Derived_1::Base ?

    dd.get();  // Derived_0::get or  Derived_1::get ?

    // 下記のようなエラーが発生する
    //  diamond_inheritance_ut.cpp:37:15: error: ‘Base’ is an ambiguous base of ‘DerivedDerived’
    //     37 |     Base& b = dd;  // Derived_0::Base or Derived_1::Base ?
    //        |               ^~
    //  diamond_inheritance_ut.cpp:39:8: error: request for member ‘get’ is ambiguous
    //     39 |     dd.get();  // Derived_0::get or  Derived_1::get ?
    //        |        ^~~

この問題に対処するには、クラス名による修飾が必要になるが、 Baseインスタンスが2つ存在するため、下記に示すようなわかりづらいバグの温床となる。

    //  example/term_explanation/diamond_inheritance_ut.cpp 53

    ASSERT_EQ(0, dd.Derived_0::get());  // クラス名による名前修飾
    ASSERT_EQ(0, dd.Derived_1::get());

    dd.Derived_0::set(1);
    ASSERT_EQ(1, dd.Derived_0::get());  // Derived_0::Base::x_は1に変更
    ASSERT_EQ(0, dd.Derived_1::get());  // Derived_1::Base::x_は0のまま

    dd.Derived_1::set(2);
    ASSERT_EQ(1, dd.Derived_0::get());  // Derived_0::Base::x_は1のまま
    ASSERT_EQ(2, dd.Derived_1::get());  // Derived_1::Base::x_は2に変更

次に示すのは、仮想継承を使用したダイヤモンド継承の例である。

    //  example/term_explanation/diamond_inheritance_ut.cpp 70

    class Base {
    public:
        int32_t get() const noexcept { return x_; }
        void    set(int32_t x) noexcept { x_ = x; }

    private:
        int32_t x_ = 0;
    };

    class Derived_0 : public virtual Base {};  // 仮想継承

    class Derived_1 : public virtual Base {};  // 仮想継承

    class DerivedDerived : public Derived_0, public Derived_1 {};
    //  example/term_explanation/diamond_inheritance_ut.cpp 90

    auto dd = DerivedDerived{};

    Base& b0 = static_cast<Derived_0&>(dd);  // Derived_0::Baseのリファレンス
    Base& b1 = static_cast<Derived_1&>(dd);  // Derived_1::Baseのリファレンス

    ASSERT_EQ(&b0, &b1);  // ddの中には、Baseインスタンスが1つできる

仮想継承の効果で、DerivedDerivedインスタンスの中に存在するBaseインスタンスは1つになるため、 上で示した仮想継承を使わないダイヤモンド継承での問題は解消される (が、仮想継承による別の問題が発生する)。

    //  example/term_explanation/diamond_inheritance_ut.cpp 99

    Base& b = dd;  // Baseインスタンスは1つであるため、コンパイルできる

    dd.get();  // Baseインスタンスは1つであるため、コンパイルできる

    dd.Derived_0::set(1);               // クラス名による修飾
    ASSERT_EQ(1, dd.Derived_1::get());  // Derived_1::BaseとDerived_1::Baseは同一であるため

    dd.set(2);
    ASSERT_EQ(2, dd.get());

この状態をオブジェクト図で表すと下記のようになる。

仮想継承

下記に示した継承方法を仮想継承、仮想継承の基底クラスを仮想基底クラスと呼ぶ。

    //  example/term_explanation/virtual_inheritance_ut.cpp 9

    class Base {
    public:
        explicit Base(int32_t x = 0) noexcept : x_{x} {}
        int32_t get() const noexcept { return x_; }

    private:
        int32_t x_;
    };

    class DerivedVirtual : public virtual Base {  // 仮想継承
    public:
        explicit DerivedVirtual(int32_t x) noexcept : Base{x} {}
    };

仮想継承は、ダイヤモンド継承の基底クラスのインスタンスを、 その継承ヒエラルキーの中で1つのみにするための言語機能である。

仮想継承の独特の動作を示すため、 上記コードに加え、仮想継承クラス、通常の継承クラス、 それぞれを通常の継承したクラスを下記のように定義する。

    //  example/term_explanation/virtual_inheritance_ut.cpp 25

    class DerivedDerivedVirtual : public DerivedVirtual {  // 仮想継承を通常の継承
    public:
        // 注: DerivedDerivedVirtualのコンストラクタは、Baseのデフォルトコンストラクタを呼び出す
        explicit DerivedDerivedVirtual(int32_t x) noexcept : DerivedVirtual{x} {}
    };

    class DerivedNormal : public Base {  // 通常の継承
    public:
        explicit DerivedNormal(int32_t x) noexcept : Base{x} {}
    };

    class DerivedDerivedNormal : public DerivedNormal {  // 通常継承を通常の継承
    public:
        explicit DerivedDerivedNormal(int32_t x) noexcept : DerivedNormal{x} {}
    };

この場合、継承ヒエラルキーに仮想継承を含むクラスと、含まないクラスでは、 以下に示したような違いが発生する。

    //  example/term_explanation/virtual_inheritance_ut.cpp 46

    auto dv = DerivedVirtual{1};  // 仮想継承クラス
    auto dn = DerivedNormal{1};   // 通常の継承クラス

    ASSERT_EQ(1, dv.get());  // これは非仮想継承と同じ動作
    ASSERT_EQ(1, dn.get());

    auto ddv = DerivedDerivedVirtual{1};  // 仮想継承クラスを継承したクラス Base::Base()が呼ばれる
    auto ddn = DerivedDerivedNormal{1};   // 通常継承クラスを継承したクラス Base::Base(1)が呼ばれる

    ASSERT_EQ(0, ddv.get());  // ddvのBaseインスタンスはのデフォルトコンストラクタで初期化されている
    ASSERT_EQ(1, ddn.get());

この動作は、下記の仕様に起因している (引数なしで呼び出せる基底クラスのコンストラクタがない場合はコンパイルエラー)。

「仮想継承クラスを継承したクラスが、仮想継承クラスの基底クラスのコンストラクタを明示的に呼び出さない場合、 引数なしで呼び出せる基底クラスのコンストラクタが呼ばれる」

以下では、これを「仮想継承のコンストラクタ呼び出し」仕様と呼ぶことにする。

仮想継承クラスが、基底クラスのコンストラクタを呼び出したとしても、この仕様が優先されるため、 上記コードのような動作となる。

これを通常の継承クラスと同様な動作にするには、下記のようにしなければならない。

    //  example/term_explanation/virtual_inheritance_ut.cpp 62

    class DerivedDerivedVirtualFixed : public DerivedVirtual {  // DerivedDerivedNormalと同じように動作
    public:
        explicit DerivedDerivedVirtualFixed(int32_t x) noexcept : Base{x}, DerivedVirtual{x} {}
        //                     基底クラスのコンストラクタ呼び出し ^^^^^^^
    };
    //  example/term_explanation/virtual_inheritance_ut.cpp 73

    DerivedDerivedVirtual      ddv{1};   // 仮想継承クラスを継承したクラス
    DerivedDerivedVirtualFixed ddvf{1};  // 上記クラスのコンストラクタを修正したクラス
    DerivedDerivedNormal       ddn{1};   // 通常の継承クラスを継承したクラス

    ASSERT_EQ(0, ddv.get());  // 仮想継承独特の動作
    ASSERT_EQ(1, ddvf.get());
    ASSERT_EQ(1, ddn.get());

「仮想継承のコンストラクタ呼び出し」仕様は、 ダイヤモンド継承での基底クラスのコンストラクタ呼び出しを一度にするために存在する。

もし、この機能がなければ、下記のコードでの基底クラスのコンストラクタ呼び出しは2度になるため、 デバッグ困難なバグが発生してしまうことは容易に想像できるだろう。

    //  example/term_explanation/virtual_inheritance_ut.cpp 88

    int32_t base_called;

    class Base {
    public:
        explicit Base(int32_t x = 0) noexcept : x_{x} { ++base_called; }
        int32_t get() const noexcept { return x_; }

    private:
        int32_t x_;
    };

    class Derived_0 : public virtual Base {  // 仮想継承
    public:
        explicit Derived_0(int32_t x) noexcept : Base{x} { assert(base_called == 1); }
    };

    class Derived_1 : public virtual Base {  // 仮想継承
    public:
        explicit Derived_1(int32_t x) noexcept : Base{x} { assert(base_called == 1); }
    };

    class DerivedDerived : public Derived_0, public Derived_1 {
    public:
        DerivedDerived(int32_t x0, int32_t x1) noexcept : Derived_0{x0}, Derived_1{x1} {}
        // 「仮想継承のコンストラクタ呼び出し」仕様がなければ、このコンストラクタは、
        //    Base::Base -> Derived_0::Derived_0 ->
        //      Base::Base -> Derived_0::Derived_0 ->
        //        DerivedDerived::DerivedDerived
        //  という呼び出しになるため、Base::Baseが2度呼び出されてしまう。
    };
    //  example/term_explanation/virtual_inheritance_ut.cpp 124

    ASSERT_EQ(0, base_called);

    auto dd = DerivedDerived{2, 3};  // Base::Baseが最初に呼ばれないとassertion failする

    ASSERT_EQ(1, base_called);  // 「仮想継承のコンストラクタ呼び出し」仕様のため
    ASSERT_EQ(0, dd.get());     // Baseのデフォルトコンストラクタは、x_を0にする

基底クラスのコンストラクタ呼び出しは、下記のコードのようにした場合でも、 単体テストが示すように、一番最初に行われる。

    //  example/term_explanation/virtual_inheritance_ut.cpp 139

    class DerivedDerived : public Derived_0, public Derived_1 {
    public:
        DerivedDerived(int32_t x0, int32_t x1) noexcept : Derived_0{x0}, Derived_1{x1}, Base{1} {}
    };
    //  example/term_explanation/virtual_inheritance_ut.cpp 151

    ASSERT_EQ(0, base_called);

    auto dd = DerivedDerived{2, 3};  // Base::Baseが最初に呼ばれないとassertion failする

    ASSERT_EQ(1, base_called);  // 「仮想継承のコンストラクタ呼び出し」仕様のため
    ASSERT_EQ(1, dd.get());     // Base{1}呼び出しの効果

このため、基底クラスのコンストラクタ呼び出しは下記のような順番で行うべきである。

    //  example/term_explanation/virtual_inheritance_ut.cpp 164

    class DerivedDerived : public Derived_0, public Derived_1 {
    public:
        DerivedDerived(int32_t x0, int32_t x1) noexcept : Base{1}, Derived_0{x0}, Derived_1{x1} {}
    };

仮想基底

仮想基底(クラス)とは、仮想継承の基底クラス指す。

ドミナンス

ドミナンス(Dominance、支配性)とは、 「探索対称の名前が継承の中にも存在するような場合のname lookupの仕様の一部」 を指す慣用句である。

以下に

のドミナンスについてのコードを例示する。

この例で示したように、ダイヤモンド継承を通常の継承で行うか、 仮想継承で行うかでは結果が全く異なるため、注意が必要である。

ダイヤモンド継承を含まない場合

    //  example/term_explanation/dominance_ut.cpp 9

    int32_t f(double) noexcept { return 0; }

    struct Base {
        int32_t f(int32_t) const noexcept { return 1; }
        int32_t f(double) const noexcept { return 2; }
    };

    struct Derived : Base {
        int32_t f(int32_t) const noexcept { return 3; }  // Base::fを隠蔽する(name-hiding)
    };

    struct DerivedDerived : Derived {
        int32_t g() const noexcept { return f(2.14); }
    };
    //  example/term_explanation/dominance_ut.cpp 29

    Base b;

    ASSERT_EQ(2, b.f(2.14));  // オーバーロード解決により、B::f(double)が呼ばれる

    DerivedDerived dd;

    // Derivedのドミナンスにより、B::fは、DerivedDerived::gでのfのname lookupの対象にならず、
    // DerivedDerived::gはDerived::fを呼び出す。
    ASSERT_EQ(3, dd.g());

このname lookupについては、name-hidingで説明した通りである。

ダイヤモンド継承かつそれが仮想継承でない場合

    //  example/term_explanation/dominance_ut.cpp 45

    struct Base {
        int32_t f(int32_t) const noexcept { return 1; }
        int32_t f(double) const noexcept { return 2; }
    };

    struct Derived_0 : Base {
        int32_t f(int32_t) const noexcept { return 3; }  // Base::fを隠蔽する(name-hiding)
    };

    struct Derived_1 : Base {};

    struct DerivedDerived : Derived_0, Derived_1 {
        int32_t g() const noexcept { return f(2.14); }  // Derived_0::f or Derived_1::f ?
    };

    // dominance_ut.cpp:58:41: error: reference to ‘f’ is ambiguous
    //    58 |     int32_t g() const noexcept { return f(2.14); }  // Derived_0::f or Derived_1::f ?
    //       |                                         ^

上記コードはコードブロック内のコメントのようなメッセージが原因でコンパイルできない。

Derived_0のドミナンスにより、DerivedDerived::gはDerived_0::fを呼び出すように見えるが、 もう一つの継承元であるDerived_1が導入したDerived_1::f(実際には、Derived_1::Base::f)があるため、 Derived_1によるドミナンスも働き、その結果として、呼び出しが曖昧(ambiguous)になることで、 このような結果となる。

ダイヤモンド継承かつそれが仮想継承である場合

    //  example/term_explanation/dominance_ut.cpp 71

    struct Base {
        int32_t f(int32_t) const noexcept { return 1; }
        int32_t f(double) const noexcept { return 2; }
    };

    struct Derived_0 : virtual Base {
        int32_t f(int32_t) const noexcept { return 3; }  // Base::fを隠蔽する(name-hiding)
    };

    struct Derived_1 : virtual Base {};

    struct DerivedDerived : Derived_0, Derived_1 {
        int32_t g() const noexcept { return f(2.14); }
    };
    //  example/term_explanation/dominance_ut.cpp 92

    DerivedDerived dd;

    // Derived_0のドミナンスと仮想継承の効果により、
    // B::fは、DerivedDerived::gでのfのname lookupの対象にならず、
    // DerivedDerived::gはDerived_0::fを呼び出す。
    ASSERT_EQ(3, dd.g());

これまでと同様にDerived_0のドミナンスによりBase::fはname-hidingされることになる。 この時、Derived_0、Derived_1がBaseから仮想継承した効果により、 この継承ヒエラルキーの中でBaseは1つのみ存在することになるため、 Derived_1により導入されたBase::fも併せてname-hidingされる。 結果として、曖昧性は排除され、コンパイルエラーにはならず、このような結果となる。

using宣言

using宣言とは、“using XXX::func”のような記述である。 この記述が行われたスコープでは、この記述後の行から名前空間XXXでの修飾をすることなく、 funcが使用できる。

    //  example/term_explanation/namespace_ut.cpp 6
    namespace XXX {
    void func() noexcept {}
    void gunc() noexcept {}
    }  // namespace XXX
    //  example/term_explanation/namespace_ut.cpp 12

    // global namespace
    void using_declaration() noexcept
    {
        using XXX::func;  // using宣言

        func();       // XXX::不要
        XXX::gunc();  // XXX::必要
    }

usingディレクティブ

usingディレクティブとは、“using namespace XXX”のような記述である。 この記述が行われたスコープでは、下記例のように、この記述後から名前空間XXXでの修飾をすることなく、 XXXの識別子が使用できる。

    //  example/term_explanation/namespace_ut.cpp 6
    namespace XXX {
    void func() noexcept {}
    void gunc() noexcept {}
    }  // namespace XXX
    //  example/term_explanation/namespace_ut.cpp 24

    // global namespace
    void using_directive() noexcept
    {
        using namespace XXX;  // usingディレクティブ

        func();  // XXX::不要
        gunc();  // XXX::不要
    }

より多くの識別子が名前空間の修飾無しで使えるようになる点において、 using宣言よりも危険であり、また、 下記のようにname-hidingされた識別子の導入には効果がない。

    //  example/term_explanation/namespace_ut.cpp 6
    namespace XXX {
    void func() noexcept {}
    void gunc() noexcept {}
    }  // namespace XXX
    //  example/term_explanation/namespace_ut.cpp 35

    namespace XXX_Inner {
    void func(int) noexcept {}
    void using_declaration() noexcept
    {
    #if 0
        using namespace XXX;  // name-hidingのため効果がない
    #else
        using XXX::func;  // using宣言
    #endif

        func();  // XXX::不要
    }

従って、usingディレクティブの使用は避けるべきである。

template強化機能

SFINAE

SFINAE (Substitution Failure Is Not An Errorの略称、スフィネェと読む)とは、 「テンプレートのパラメータ置き換えに失敗した(ill-formedになった)際に、 即時にコンパイルエラーとはせず、置き換えに失敗したテンプレートを name lookupの候補から除外する」 という言語機能である。

コンセプト

C++17までのテンプレートには以下のような問題があった。

C++20から導入された「コンセプト(concepts)」は、 テンプレートパラメータを制約する機能である。 この機能を使用することで、以下のようなプログラミングでのメリットが得られる。

    //  example/term_explanation/concept_ut.cpp 12

    // SFINAEを使用したc++17スタイル
    template <typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
    T add(T a, T b)
    {
        return a + b;
    }

    //  example/term_explanation/concept_ut.cpp 24

    ASSERT_EQ(add(10, 20), 30);     // int型
    ASSERT_EQ(add(1.5, 2.5), 4.0);  // double型

    auto str1 = std::string{"Hello, "};
    auto str2 = std::string{"World!"};
    // add(str1, str2);  // これを試すとコンパイルエラー
    // concept_ut.cpp:10:3: note: candidate: ‘template<class T, class> T
    // {anonymous}::old_style::add(T, T)’
    //    10 | T add(T a, T b) {
    //       |   ^~~
    // concept_ut.cpp:10:3: note:   template argument deduction/substitution failed:
    // concept_ut.cpp:9:22: error: no type named ‘type’ in ‘struct std::enable_if<false, void>’
    //     9 | template<typename T, typename = typename
    //     std::enable_if<std::is_arithmetic<T>::value>::type>
    //       |                      ^~~~~~~~
    // エラーメッセージがわかりずらい
    //  example/term_explanation/concept_ut.cpp 49

    // コンセプトを使用したC++20スタイル
    template <typename T>
    concept Arithmetic = std::is_arithmetic_v<T>;

    template <Arithmetic T>
    T add(T a, T b)
    {
        return a + b;
    }

    //  example/term_explanation/concept_ut.cpp 64

    ASSERT_EQ(add(10, 20), 30);     // int型
    ASSERT_EQ(add(1.5, 2.5), 4.0);  // double型

    auto str1 = std::string{"Hello, "};
    auto str2 = std::string{"World!"};
    // add(str1, str2);  // これを試すとコンパイルエラー
    // concept_ut.cpp:36:27: note: the expression ‘is_arithmetic_v<T> [with T =
    // std::basic_string<char, std
    // ::char_traits<char>, std::allocator<char> >]’ evaluated to ‘false’
    //    36 | concept Arithmetic = std::is_arithmetic_v<T>;
    //       |                      ~~~~~^~~~~~~~~~~~~~~~~~
    // ↑  エラーメッセージがわかりよい。テンプレートTがコンセプトfalseとなる

以下はテンプレートパラメータの制約にstatic_assertを使用した例である。

    //  example/term_explanation/concept_ut.cpp 85

    // 制約のためにstatic_assertを使用したC++17スタイル
    template <typename FLOAT_0, typename FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs) noexcept
    {
        static_assert(std::is_floating_point_v<FLOAT_0>, "FLOAT_0 shoud be float or double.");
        static_assert(std::is_same_v<FLOAT_0, FLOAT_1>, "FLOAT_0 and FLOAT_1 shoud be a same type.");

        return std::abs(lhs - rhs) <= std::numeric_limits<FLOAT_0>::epsilon();
    }

以上の関数テンプレートをコンセプトを使用して改善した例である。

    //  example/term_explanation/concept_ut.cpp 113

    // 標準コンセプト std::floating_point と std::same_as を使用
    template <std::floating_point FLOAT_0, std::same_as<FLOAT_0> FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs) noexcept
    {
        return std::abs(lhs - rhs) <= std::numeric_limits<FLOAT_0>::epsilon();
    }

フレキシブルに制約を記述するためにrequiresを使用したコード例を下記する。

    //  example/term_explanation/concept_ut.cpp 138

    #if __cplusplus >= 202002L  // c++20

    // requiresを使った関数テンプレートの制約
    template <typename FLOAT_0, typename FLOAT_1>
    requires std::floating_point<FLOAT_0> && std::same_as<FLOAT_0, FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs) noexcept
    {
        return std::abs(lhs - rhs) <= std::numeric_limits<FLOAT_0>::epsilon();
    }

    #else  // c++17
    template <typename FLOAT_0, typename FLOAT_1>
    bool is_equal(FLOAT_0 lhs, FLOAT_1 rhs) noexcept
    {
        static_assert(std::is_same_v<FLOAT_0, FLOAT_1>);
        return std::abs(lhs - rhs) <= std::numeric_limits<FLOAT_0>::epsilon();
    }
    #endif

畳み込み式

畳み式(fold expression)とは、C++17から導入された新機能であり、 可変引数テンプレートのパラメータパックに対して二項演算を累積的に行うためのものである。

畳み込み式のシンタックスの使用は下記のようなものである。

( pack op ... )          // (1) 単項右畳み込み
( ... op pack )          // (2) 単項左畳み込み
( pack op ... op init )  // (3) 二項右畳み込み
( init op ... op pack )  // (4) 二項左畳み込み
  1. 単項右畳み込み
    //  example/term_explanation/flold_expression_ut.cpp 9

    namespace cpp14_style {  // c++14までのスタイル
    template <typename T>
    constexpr bool all_true(T arg)
    {
        return arg;
    }
    template <typename T, typename... Args>
    constexpr bool all_true(T arg, Args... args)
    {
        return arg && all_true(args...);
    }
    }  // namespace cpp14_style

    namespace cpp17_style {  // 畳み込み式を使用したスタイル
    template <typename... Ts>
    constexpr bool all_true(Ts... args)
    {
        return (args && ...);  // 単項右畳み込み
    }
    }  // namespace cpp17_style

    static_assert(cpp14_style::all_true(true, true, true));
    static_assert(cpp17_style::all_true(true, true, true));
  1. 単項左畳み込み
    //  example/term_explanation/flold_expression_ut.cpp 36
    namespace cpp14_style {  // c++14までのスタイル
    template <typename T>
    constexpr bool any_true(T arg)
    {
        return arg;
    }
    template <typename T, typename... Args>
    constexpr bool any_true(T arg, Args... args)
    {
        return arg || any_true(args...);
    }
    }  // namespace cpp14_style

    namespace cpp17_style {  // 畳み込み式を使用したスタイル
    template <typename... Ts>
    constexpr bool any_true(Ts... args)
    {
        return (... || args);  // 単項左畳み込み
    }
    }  // namespace cpp17_style
    static_assert(cpp14_style::any_true(false, false, true));
    static_assert(cpp17_style::any_true(false, false, true));
  1. 二項右畳み込み
    //  example/term_explanation/flold_expression_ut.cpp 61

    namespace cpp14_style {  // c++14までのスタイル
    template <typename T>
    constexpr int sum(T arg)
    {
        return arg;
    }
    template <typename T, typename... Args>
    constexpr int sum(T arg, Args... args)
    {
        return arg + sum(args...);
    }

    }  // namespace cpp14_style

    namespace cpp17_style {  // 畳み込み式を使用したスタイル
    template <typename... Ts>
    constexpr int sum(Ts... args)
    {
        return (args + ... + 0);  // 二項右畳み込み (初期値: 0)
    }
    }  // namespace cpp17_style

    static_assert(cpp14_style::sum(1, 2, 3));
    static_assert(cpp17_style::sum(1, 2, 3));
  1. 二項左畳み込み
    //  example/term_explanation/flold_expression_ut.cpp 89

    namespace cpp14_style {  // c++14までのスタイル
    template <typename T>
    constexpr int product(T arg)
    {
        return arg;
    }
    template <typename T, typename... Args>
    constexpr int product(T arg, Args... args)
    {
        return arg * product(args...);
    }
    }  // namespace cpp14_style

    namespace cpp17_style {  // 畳み込み式を使用したスタイル
    template <typename... Ts>
    constexpr int product(Ts... args)
    {
        return (1 * ... * args);  // 二項左畳み込み (初期値: 1)
    }
    }  // namespace cpp17_style

    static_assert(cpp14_style::product(2, 3, 4));
    static_assert(cpp17_style::product(2, 3, 4));

上記したような単純な例では、畳み込み式の効果はわかりづらいため、 もっと複雑なで読解が困難な再帰構造を持ったコードを以下に示す。

    //  example/term_explanation/flold_expression_ut.cpp 117
    template <typename T, typename U, typename... Us>
    struct is_same_some_of {
        static constexpr bool value{std::is_same_v<T, U> ? true : is_same_some_of<T, Us...>::value};
    };

    template <typename T, typename U>
    struct is_same_some_of<T, U> {
        static constexpr bool value{std::is_same_v<T, U>};
    };
    //  example/term_explanation/flold_expression_ut.cpp 128

    static_assert(is_same_some_of<int, int, double, char>::value);
    static_assert(!is_same_some_of<int, double, char>::value);
    static_assert(is_same_some_of<std::string, std::string, int>::value);

畳み込み式を使うことで、この問題をある程度緩和したコードを下記する。

    //  example/term_explanation/flold_expression_ut.cpp 140
    template <typename T, typename U, typename... Us>
    struct is_same_some_of {
        static constexpr bool value = (std::is_same_v<T, U> || ... || std::is_same_v<T, Us>);
    };
    //  example/term_explanation/flold_expression_ut.cpp 146

    static_assert(is_same_some_of<int, int, double, char>::value);
    static_assert(!is_same_some_of<int, double, char>::value);
    static_assert(is_same_some_of<std::string, std::string, int>::value);

ジェネリックラムダ

ジェネリックラムダとは、C++11のラムダ式のパラメータの型にautoを指定できるようにした機能で、 C++14で導入された。

この機能により関数の中で関数テンプレートと同等のものが定義できるようになった。

ジェネリックラムダで定義されたクロージャは、通常のラムダと同様にオブジェクトであるため、 下記のように使用することもできる便利な記法である。

    //  example/term_explanation/generic_lambda_ut.cpp 4

    template <typename PUTTO>
    void f(PUTTO&& p)
    {
        p(1);
        p(2.71);
        p("str");
    }

    TEST(Template, generic_lambda)
    {
        std::ostringstream oss;

        f([&oss](auto const& elem) { oss << elem << std::endl; });

        ASSERT_EQ("1\n2.71\nstr\n", oss.str());
    }

なお、上記のジェネリックラムダは下記クラスのインスタンスの動きと同じである。

    //  example/term_explanation/generic_lambda_ut.cpp 23

    class Closure {
    public:
        Closure(std::ostream& os) : os_(os) {}

        template <typename T>
        void operator()(T&& t)
        {
            os_ << t << std::endl;
        }

    private:
        std::ostream& os_;
    };

    TEST(Template, generic_lambda_like)
    {
        std::ostringstream oss;

        Closure closure(oss);
        f(closure);

        ASSERT_EQ("1\n2.71\nstr\n", oss.str());
    }

クラステンプレートのテンプレート引数の型推論

C++17から、 「コンストラクタに渡される値によって、クラステンプレートのテンプレート引数を推論する」 機能が導入された。

この機能がないC++14までは以下のように記述する必要があった。

    //  example/term_explanation/template_ut.cpp 13

    auto a = std::vector<int>{1, 2, 3};

    static_assert(std::is_same_v<decltype(a), std::vector<int>>);

これに対して、この機能により、以下のようにシンプルに記述できるようになった。

    //  example/term_explanation/template_ut.cpp 24

    auto a = std::vector{1, 2, 3};

    static_assert(std::is_same_v<decltype(a), std::vector<int>>);  // テンプレート引数がintと推論

テンプレートの型推論ガイド

テンプレートの型推論ガイド(CTAD(Class Template Argument Deduction))は、 C++17で導入された機能である。この機能により、 クラステンプレートのインスタンス化時にテンプレート引数を明示的に指定せず、 引数から自動的に型を推論できるようになる。型推論ガイドを使用することで、 コードの可読性と簡潔性が向上する。

型推論ガイドがない場合、クラステンプレートのテンプレート引数の型推論は限定的であり、 明示的にテンプレート引数を指定する必要がある場合が多い。 一方、型推論ガイドを使用することで、 コンストラクタの引数からテンプレート引数を自動的に決定することが可能になる。

    //  example/term_explanation/deduction_guide_ut.cpp 8

    template <typename T>  // Tが整数型の場合、暗黙の型変換を許可
    struct S {
        // T が整数型でない場合に有効なコンストラクタ
        template <typename U = T, std::enable_if_t<!std::is_integral_v<U>>* = nullptr>
        explicit S(U x) : value{x}
        {
        }

        // T が整数型の場合に有効な非explicitコンストラクタ
        template <typename U = T, std::enable_if_t<std::is_integral_v<U>>* = nullptr>
        S(U x) : value{x}
        {
        }

        T value;
    };

上記のクラステンプレートは、ガイドがない場合、 以下に示すように型推論によりテンプレート引数を決定することができない。

    //  example/term_explanation/deduction_guide_ut.cpp 31

    S<int>    s1{42};   // 明示的にテンプレート引数を指定
    S<double> s2{1.0};  // 明示的にテンプレート引数を指定

    // テンプレート引数の推論ができず、下記はコンパイルできない
    // S       s1{42};   // 明示的にテンプレート引数を指定
    // S       s2{1.0};  // 明示的にテンプレート引数を指定

以上に示したクラステンプレートに以下の型推論ガイドを追加することにより、 テンプレート引数を型推論できるようになる。

    //  example/term_explanation/deduction_guide_ut.cpp 44

    template <typename T>
    S(T) -> S<T>;
    //  example/term_explanation/deduction_guide_ut.cpp 52

    S s1{42};   // 推論ガイドの効果
    S s2{1.0};  // 推論ガイドの効果
    S s3 = 42;  // S<int>のコンストラクタがintであるため、暗黙の型変換が可能
    // S    s4 = 1.0;  // S<double>のコンストラクタがexplicitであるため

CTAD(Class Template Argument Deduction)

CTAD(Class Template Argument Deduction)とは、テンプレートの型推論ガイドのことである。

変数テンプレート

変数テンプレートとは、下記のコード示したような機能である。

    //  example/term_explanation/template_ut.cpp 32

    template <typename T>
    struct is_void {
        static constexpr bool value = false;
    };

    template <>
    struct is_void<void> {
        static constexpr bool value = true;
    };

    static_assert(is_void<void>::value);
    static_assert(!is_void<int>::value);
    // 以上はC++14以前のスタイル

    // 以下はC++17から導入された
    template <typename T>
    constexpr bool is_void_v = is_void<T>::value;

    static_assert(is_void_v<void>);
    static_assert(!is_void_v<int>);

なお、変数テンプレートはconstexprと定義されるが、 「定数テンプレート」ではなく変数テンプレートである。

エイリアステンプレート

エイリアステンプレート(alias templates)とはC++11から導入され、 下記のコード例で示したようにテンプレートによって型の別名を定義する機能である。

    //  example/term_explanation/template_ut.cpp 56

    using IntVector = std::vector<int>;  // std::vector<int> のエイリアスを定義

    template <typename T>  //エイリアステンプレートを定義
    using Vec = std::vector<T>;

    static_assert(std::is_same_v<IntVector, Vec<int>>);  // Vec<int> == std::vector<int>

constexpr if文

C++17で導入されたconstexpr if文とは、 文を条件付きコンパイルすることができるようにするための制御構文である。

まずは、この構文を使用しない例を示す。

    //  example/term_explanation/constexpr_if_ut.cpp 9

    // 配列のサイズ
    template <typename T>
    auto Length(T const&) -> std::enable_if_t<std::is_array_v<T>, size_t>
    {
        return std::extent_v<T>;
    }

    // コンテナのサイズ
    template <typename T>
    auto Length(T const& t) -> decltype(t.size())
    {
        return t.size();
    }

    // その他のサイズ
    size_t Length(...) { return 0; }
    //  example/term_explanation/constexpr_if_ut.cpp 31

    uint32_t a[5];
    auto     v = std::vector{0, 1, 2};
    struct SizeTest {
    } t;

    ASSERT_EQ(5, Length(a));
    ASSERT_EQ(3, Length(v));
    ASSERT_EQ(0, Length(t));

    // C++17で、Lengthと同様の機能の関数テンプレートがSTLに追加された
    ASSERT_EQ(std::size(a), Length(a));
    ASSERT_EQ(std::size(v), Length(v));

このような場合、SFINAEによるオーバーロードが必須であったが、 この文を使用することで、下記のようにオーバーロードを使用せずに記述できるため、 条件分岐の可読性の向上が見込める。

    //  example/term_explanation/constexpr_if_ut.cpp 52

    struct helper {
        template <typename T>
        auto operator()(T const& t) -> decltype(t.size());
    };

    template <typename T>
    size_t Length(T const& t)
    {
        if constexpr (std::is_array_v<T>) {  // Tが配列の場合
            // Tが配列でない場合、他の条件のブロックはコンパイル対象外
            return std::extent_v<T>;
        }
        else if constexpr (std::is_invocable_v<helper, T>) {  // T::Lengthが呼び出せる場合
            // T::Lengthが呼び出せない場合、他の条件のブロックはコンパイル対象外
            return t.size();
        }
        else {  // それ以外
            // Tが配列でなく且つ、T::Lengthが呼び出ない場合、他の条件のブロックはコンパイル対象外
            return 0;
        }
    }

この構文はパラメータパックの展開においても有用な場合がある。

    //  example/term_explanation/constexpr_if_ut.cpp 93

    // テンプレートパラメータで与えられた型のsizeofの値が最も大きな値を返す。
    template <typename HEAD>
    constexpr size_t MaxSizeof()
    {
        return sizeof(HEAD);
    }

    template <typename HEAD, typename T, typename... TAILS>
    constexpr size_t MaxSizeof()
    {
        return std::max(sizeof(HEAD), MaxSizeof<T, TAILS...>());
    }
    //  example/term_explanation/constexpr_if_ut.cpp 111

    static_assert(4 == (MaxSizeof<int8_t, int16_t, int32_t>()));
    static_assert(4 == (MaxSizeof<int32_t, int16_t, int8_t>()));
    static_assert(sizeof(std::string) == MaxSizeof<int32_t, int16_t, int8_t, std::string>());

C++14までの構文を使用する場合、 上記のようなオーバーロードとリカーシブコールの組み合わせが必要であったが、 constexpr ifを使用することで、やや単純に記述できる。

    //  example/term_explanation/constexpr_if_ut.cpp 123

    // テンプレートパラメータで与えられた型のsizeofの値が最も大きな値を返す。
    template <typename HEAD, typename... TAILS>
    constexpr size_t MaxSizeof()
    {
        if constexpr (sizeof...(TAILS) == 0) {  // TAILSが存在しない場合
            return sizeof(HEAD);
        }
        else {
            return std::max(sizeof(HEAD), MaxSizeof<TAILS...>());
        }
    }

autoパラメータによる関数テンプレートの簡易定義

この機能は、C++20から導入された。 下記のコードで示すように簡易的に関数テンプレートを定義するための機能である。

    //  example/term_explanation/decltype_ut.cpp 182

    #if __cplusplus >= 202002L  // c++20
    auto add(auto lhs, auto rhs) { 
        return lhs + rhs; 
    }

    #else  // c++17
    template <typename T, typename U>
    auto add(T lhs, U rhs)
    {
        return lhs + rhs;
    }
    #endif
    //  example/term_explanation/decltype_ut.cpp 201

    ASSERT_EQ(add(1, 2), 3);

    ASSERT_DOUBLE_EQ(add(1.5, 2.5), 4.0);

    using namespace std::literals::string_literals;

    ASSERT_EQ(add("hello"s, "world"s), "helloworld"s);

型推論

AAAスタイル

このドキュメントでのAAAとは、単体テストのパターンarrange-act-assertではなく、 almost always autoを指し、 AAAスタイルとは、「可能な場合、型を左辺に明示して変数を宣言する代わりに、autoを使用する」 というコーディングスタイルである。 この用語は、Andrei Alexandrescuによって造られ、Herb Sutterによって広く推奨されている。

特定の型を明示して使用する必要がない場合、下記のように書く。

    //  example/term_explanation/aaa.cpp 11

    auto i  = 1;
    auto ui = 1U;
    auto d  = 1.0;
    auto s  = "str";
    auto v  = {0, 1, 2};

    for (auto i : v) {
        // 何らかの処理
    }

    auto add = [](auto lhs, auto rhs) {  // -> return_typeのような記述は不要
        return lhs + rhs;                // addの型もautoで良い
    };

    // 上記変数の型の確認
    static_assert(std::is_same_v<decltype(i), int>);
    static_assert(std::is_same_v<decltype(ui), unsigned int>);
    static_assert(std::is_same_v<decltype(d), double>);
    static_assert(std::is_same_v<decltype(s), char const*>);
    static_assert(std::is_same_v<decltype(v), std::initializer_list<int>>);

    char s2[] = "str";  // 配列の宣言には、AAAは使えない
    static_assert(std::is_same_v<decltype(s2), char[4]>);

    int* p0 = nullptr;  // 初期値がnullptrであるポインタの初期化には、AAAは使うべきではない
    auto p1 = static_cast<int*>(nullptr);  // NG
    auto p2 = p0;                          // OK
    auto p3 = nullptr;                     // NG 通常、想定通りにならない
    static_assert(std::is_same_v<decltype(p3), std::nullptr_t>);

特定の型を明示して使用する必要がある場合、下記のように書く。

    //  example/term_explanation/aaa.cpp 51

    auto b  = new char[10]{0};
    auto v  = std::vector<int>{0, 1, 2};
    auto s  = std::string{"str"};
    auto sv = std::string_view{"str"};

    static_assert(std::is_same_v<decltype(b), char*>);
    static_assert(std::is_same_v<decltype(v), std::vector<int>>);
    static_assert(std::is_same_v<decltype(s), std::string>);
    static_assert(std::is_same_v<decltype(sv), std::string_view>);

    // 大量のstd::stringオブジェクトを定義する場合
    using std::literals::string_literals::operator""s;

    auto s_0 = "222"s;  // OK
    // ...
    auto s_N = "222"s;  // OK

    static_assert(std::is_same_v<decltype(s_0), std::string>);
    static_assert(std::is_same_v<decltype(s_N), std::string>);

    // 大量のstd::string_viewオブジェクトを定義する場合
    using std::literals::string_view_literals::operator""sv;

    auto sv_0 = "222"sv;  // OK
    // ...
    auto sv_N = "222"sv;  // OK

    static_assert(std::is_same_v<decltype(sv_0), std::string_view>);
    static_assert(std::is_same_v<decltype(sv_N), std::string_view>);

    std::mutex mtx;  // std::mutexはmove出来ないので、AAAスタイル不可
    auto       lock = std::lock_guard{mtx};

    static_assert(std::is_same_v<decltype(lock), std::lock_guard<std::mutex>>);

関数の戻り値を受け取る変数を宣言する場合、下記のように書く。

    //  example/term_explanation/aaa.cpp 94

    auto v = std::vector<int>{0, 1, 2};

    // AAAを使わない例
    std::vector<int>::size_type t0{v.size()};      // 正確に書くとこうなる
    std::vector<int>::iterator  itr0 = v.begin();  // 正確に書くとこうなる

    std::unique_ptr<int> p0 = std::make_unique<int>(3);

    // 上記をAAAにした例
    auto t1   = v.size();   // size()の戻りは算術型であると推測できる
    auto itr1 = v.begin();  // begin()の戻りはイテレータであると推測できる

    auto p1 = std::make_unique<int>(3);  // make_uniqueの戻りはstd::unique_ptrであると推測できる

ただし、関数の戻り値型が容易に推測しがたい下記のような場合、 型を明示しないAAAスタイルは使うべきではない。

    //  example/term_explanation/aaa.cpp 118

    extern std::map<std::string, int> gen_map();

    // 上記のような複雑な型を戻す関数の場合、AAAを使うと可読性が落ちる
    auto map0 = gen_map();

    for (auto [str, i] : gen_map()) {
        // 何らかの処理
    }

    // 上記のような複雑な型を戻す関数の場合、AAAを使うと可読性が落ちるため、AAAにしない
    std::map<std::string, int> map1 = gen_map();  // 型がコメントとして役に立つ

    for (std::pair<std::string, int> str_i : gen_map()) {
        // 何らかの処理
    }

    // 型を明示したAAAスタイルでも良い
    auto map2 = std::map<std::string, int>{gen_map()};  // 型がコメントとして役に立つ

インライン関数や関数テンプレートの宣言は、下記のように書く。

    //  example/term_explanation/aaa.cpp 145

    template <typename F, typename T>
    auto apply_0(F&& f, T value)
    {
        return f(value);
    }

ただし、インライン関数や関数テンプレートが複雑な下記のような場合、 AAAスタイルは出来る限り避けるべきである。

    //  example/term_explanation/aaa.cpp 153

    template <typename F, typename T>
    auto apply_1(F&& f, T value) -> decltype(f(std::declval<T>()))  // autoを使用しているが、AAAではない
    {
        auto cond  = false;
        auto param = value;

        // 複雑な処理

        if (cond) {
            return f(param);
        }
        else {
            return f(value);
        }
    }

このスタイルには下記のような狙いがある。

    //  example/term_explanation/aaa.cpp 180

    auto v = std::vector<int>{0, 1, 2};

    int t0 = v.size();  // 縮小型変換されるため、バグが発生する可能性がある
    // int t1{v.size()};   縮小型変換のため、コンパイルエラー
    auto t2 = v.size();  // t2は正確な型

AAAスタイルでは、以下のような場合に注意が必要である。

    //  example/term_explanation/aaa.cpp 194

    auto str0 = "str";
    static_assert(std::is_same_v<char const*, decltype(str0)>);  // str0はchar[4]ではない

    // char[]が必要ならば、AAAを使わずに下記のように書く
    char str1[] = "str";
    static_assert(std::is_same_v<char[4], decltype(str1)>);

    // &が必要になるパターン
    class X {
    public:
        explicit X(int32_t a) : a_{a} {}
        int32_t& Get() { return a_; }

    private:
        int32_t a_;
    };

    X x{3};

    auto a0 = x.Get();
    ASSERT_EQ(3, a0);

    a0 = 4;
    ASSERT_EQ(4, a0);
    ASSERT_EQ(3, x.Get());  // a0はリファレンスではないため、このような結果になる

    // X::a_のリファレンスが必要ならば、下記のように書く
    auto& a1 = x.Get();
    a1       = 4;
    ASSERT_EQ(4, a1);
    ASSERT_EQ(4, x.Get());  // a1はリファレンスであるため、このような結果になる

    // constが必要になるパターン
    class Y {
    public:
        std::string&       Name() { return name_; }
        std::string const& Name() const { return name_; }

    private:
        std::string name_{"str"};
    };

    auto const y = Y{};

    auto        name0 = y.Name();  // std::stringがコピーされる
    auto&       name1 = y.Name();  // name1はconstに見えない
    auto const& name2 = y.Name();  // このように書くべき

    static_assert(std::is_same_v<std::string, decltype(name0)>);
    static_assert(std::is_same_v<std::string const&, decltype(name1)>);
    static_assert(std::is_same_v<std::string const&, decltype(name2)>);

    // 範囲for文でのauto const&
    auto const v = std::vector<std::string>{"0", "1", "2"};

    for (auto s : v) {  // sはコピー生成される
        static_assert(std::is_same_v<std::string, decltype(s)>);
    }

    for (auto& s : v) {  // sはconstに見えない
        static_assert(std::is_same_v<std::string const&, decltype(s)>);
    }

    for (auto const& s : v) {  // このように書くべき
        static_assert(std::is_same_v<std::string const&, decltype(s)>);
    }

decltype

decltypeはオペランドにexpressionを取り、その型を算出する機能である。 下記のコードにあるようなautoの機能との微妙な差に気を付ける必要がある。

    //  example/term_explanation/decltype_ut.cpp 13

    int32_t  x{3};
    int32_t& r{x};

    auto        a = r;  // aの型はint32_t
    decltype(r) b = r;  // bの型はint32_t&

    // std::is_sameはオペランドの型が同じか否かを返すメタ関数
    static_assert(std::is_same_v<decltype(a), int>);
    static_assert(std::is_same_v<decltype(b), int&>);

decltypeは、テンプレートプログラミングに多用されるが、 クロージャ型(「ラムダ式」参照) のような記述不可能な型をオブジェクトから算出できるため、 下記例のような場合にも有用である。

    //  example/term_explanation/decltype_ut.cpp 28

    //  本来ならばA::dataは、
    //      * A::Aでメモリ割り当て
    //      * A::~Aでメモリ解放
    //  すべきだが、何らかの理由でそれが出来ないとする
    struct A {
        size_t   len;
        uint8_t* data;
    };

    void do_something(size_t len)
    {
        auto deallocate = [](A* p) {
            delete[](p->data);
            delete p;
        };

        auto a_ptr = std::unique_ptr<A, decltype(deallocate)>{new A, deallocate};

        a_ptr->len  = len;
        a_ptr->data = new uint8_t[10];

        // ...
        // do something for a_ptr
        // ...

        // a_ptrによるメモリの自動解放
    }

decltype(auto)

decltype(auto)はC++14から導入されたdecltypeの類似機能である。

auto、decltype、decltype(auto)では、以下に示す通りリファレンスの扱いが異なることに注意する必要がある。

    //  example/term_explanation/decltype_ut.cpp 63

    int32_t  x{3};
    int32_t& r{x};

    auto           a = r;  // aの型はint32_t
    decltype(r)    b = r;  // bの型はint32_t&
    decltype(auto) c = r;  // cの型はint32_t&   C++14からサポート
                           // decltype(auto)は、decltypeに右辺の式を与えるための構文

    // std::is_sameはオペランドの型が同じか否かを返すメタ関数
    static_assert(std::is_same_v<decltype(a), int>);
    static_assert(std::is_same_v<decltype(b), int&>);
    static_assert(std::is_same_v<decltype(c), int&>);

CTAD(Class Template Argument Deduction)

戻り値型を後置する関数宣言

関数の戻り値型後置構文は戻り値型をプレースホルダ(auto)にして、 実際の型を->で示して型推論させるシンタックスを指す。実際には関数テンプレートで使用されることが多い。 コード例を以下に示す。

    //  example/term_explanation/decltype_ut.cpp 82

    template <typename T, typename U>
    auto add(T a, U b) -> decltype(a + b)
    {
        return a + b;
    }

    static_assert(std::is_same_v<decltype(add(1, 2)), int>);         // addの戻り値型はintに型推論
    static_assert(std::is_same_v<decltype(add(1u, 2u)), uint32_t>);  // addの戻り値型はintに型推論
    static_assert(std::is_same_v<decltype(add(std::string{"str"}, "2")),
                                 std::string>);  // addの戻り値型はstd::stringに型推論

この構文をC++11から導入された理由は以下のコードを見れば明らかだろう。

    //  example/term_explanation/decltype_ut.cpp 97

    template <typename T, typename U>  // 戻り値型を後置する関数宣言
    decltype(std::declval<T>() + std::declval<T>()) add(T a, U b)
    {
        return a + b;
    }

    static_assert(std::is_same_v<decltype(add(1, 2)), int>);         // addの戻り値型はintに型推論
    static_assert(std::is_same_v<decltype(add(1u, 2u)), uint32_t>);  // addの戻り値型はintに型推論
    static_assert(std::is_same_v<decltype(add(std::string{"str"}, "2")),
                                 std::string>);  // addの戻り値型はstd::stringに型推論

関数の戻り値型auto

C++14から導入された機能で、関数の戻り値の型をautoキーワードで宣言することで、 コンパイラがreturn文から自動的に型を推論してくれる機能である。 これにより、複雑な型の戻り値を持つ関数でも、より簡潔に記述できるようになる (「autoパラメータによる関数テンプレートの簡易定義」を参照)。

    //  example/term_explanation/decltype_ut.cpp 114

    // 戻り値型autoが使えないと下記のような宣言が必要
    // std::vector<std::string> split(std::string_view str, char delimiter)
    auto split(std::string_view str, char delimiter)
    {
        std::vector<std::string> result;
        std::string              token;

        for (char ch : str) {
            if (ch == delimiter) {
                if (!token.empty()) {
                    result.emplace_back(std::move(token));
                }
            }
            else {
                token += ch;
            }
        }

        if (!token.empty()) {
            result.emplace_back(std::move(token));
        }

        return result;
    }
    //  example/term_explanation/decltype_ut.cpp 144

    auto result = split("hello,world", ',');

    ASSERT_EQ(result.size(), 2);
    ASSERT_EQ(result[0], "hello");
    ASSERT_EQ(result[1], "world");

後置戻り値型auto

C++14から導入された関数の戻り値型autoと似た、 関数の戻り値の型を関数本体の後に-> autoと書くことでができる機能である。 autoプレースホルダーとし、そのプレースホルダーを修飾することで、戻り値型の推論を補助できる。

    //  example/term_explanation/decltype_ut.cpp 154

    int16_t gvalue = 1;

    auto getValue(int16_t a) -> auto& { return gvalue += a; }
    //  example/term_explanation/decltype_ut.cpp 163

    auto           ret1 = getValue(10);
    decltype(auto) ret2 = getValue(0);

    ASSERT_EQ(ret1, 11);
    ASSERT_EQ(ret2, 11);

    ASSERT_EQ(gvalue, 11);
    ret1 += 1;
    ASSERT_EQ(gvalue, 11);

    ret2 += 1;
    ASSERT_EQ(gvalue, 12);

explicit

explicitは、コンストラクタに対して付与することで、 コンストラクタによる暗黙の型変換を禁止するためのキーワードである。 暗黙の型変換とは、ある型の値を別の型の値に自動的に変換する言語機能を指す。 explicitキーワードを付けることで、意図しない型変換を防ぎ、コードの堅牢性を高めることがでできる。

この節で説明するexplicitの機能は下記のような項目に渡って説明を行う。

暗黙の型変換

この節で扱う暗黙の型変換とは、 以下に示したような「非explicitなコンストラクタを持つクラス」による暗黙の型変換を指し、 汎整数型昇格算術変換等を指さない。

    //  example/term_explanation/implicit_conversion_ut.cpp 8

    class Person {
    public:
        Person(char const* name, uint32_t age = 0) : name_{name}, age_{age} {}
        Person(Person const&)            = default;
        Person& operator=(Person const&) = default;

        std::string const& GetName() const noexcept { return name_; }
        uint32_t           GetAge() const noexcept { return age_; }

    private:
        std::string name_;  // コピーをするため非const
        uint32_t    age_;
    };

    #if __cplusplus <= 201703L  // c++17
    bool operator==(Person const& lhs, Person const& rhs) noexcept
    {
        return std::tuple(lhs.GetName(), lhs.GetAge()) == std::tuple(rhs.GetName(), rhs.GetAge());
    }

    #else  // c++20
    auto operator<=>(Person const& lhs, Person const& rhs) noexcept
    {
        return std::tuple(lhs.GetName(), lhs.GetAge()) <=> std::tuple(rhs.GetName(), rhs.GetAge());
    }

    // <=>から自動的に==が生成されないため、明示的に定義する必要がある
    bool operator==(Person const& lhs, Person const& rhs) noexcept { return (lhs <=> rhs) == 0; }
    #endif

上記のクラスPersonを使用して、下記のようなコードをコンパイルできるようにする機能である。

    //  example/term_explanation/implicit_conversion_ut.cpp 40

    void f(Person const& person) noexcept
    {
        // ...
    }

    void using_implicit_coversion()
    {
        f("Ohtani");  // "Ohtani"はPerson型ではないが、コンパイル可能
    }

この記法は下記コードの短縮形であり、コードの見た目をシンプルに保つ効果がある。

    //  example/term_explanation/implicit_conversion_ut.cpp 54

    void not_using_implicit_coversion()
    {
        f(Person{"Ohtani"});  // 本来は、fの引数はPerson型
    }

この記法は下記のようにstd::string等のSTLでも多用され、その効果は十分に発揮されているものの、

    //  example/term_explanation/implicit_conversion_ut.cpp 66

    auto otani = std::string{"Ohtani"};

    // ...

    if (otani == "Ohtani") {  // 暗黙の型変換によりコンパイルできる
        // ...
    }

以下のようなコードがコンパイルできてしまうため、わかりづらいバグの元にもなる。

    //  example/term_explanation/implicit_conversion_ut.cpp 80

    auto otani = Person{"Ohtani", 26};

    // ...

    if (otani == "Otani") {  // このコードがコンパイルされる。
        // ...
    }

    if (otani == Person{"Otani"}) {  // 暗黙の型変換を使わない記法
        // ...
    }

下記のようにコンストラクタにexplicitを付けて宣言することにより、この問題を防ぐことができる。

    //  example/term_explanation/implicit_conversion_ut.cpp 112

    class Person {
    public:
        explicit Person(char const* name, uint32_t age = 0) : name_{name}, age_{age} {}
        Person(Person const&)            = default;
        Person& operator=(Person const&) = default;

        // ...
    };

    void prohibit_implicit_coversion()
    {
    #if 0  // explicit付きのコンストラクタを持つPersonと違い、コンパイルできない。
        f("Ohtani");
    #else
        f(Person{"Ohtani"});
    #endif

        auto otani = Person{"Ohtani", 26};

        // ...

    #if 0
        if (otani == "Otani") {  // このコードもコンパイルできない。
            // ...
        }
    #else
        if (otani == Person{"Otani", 26}) {  // この記述を強制できる。
            // ...
        }
    #endif
    }

std::stringは暗黙の型変換を許して良く、(多くの場合)Personには暗黙の型変換をしない方が良い理由は、

といったセマンティクス的観点(「シンタックス、セマンティクス」参照)によるものである。

クラスPersonと同様に、 ほとんどのユーザ定義クラスには非explicitなコンストラクタによる暗黙の型変換は必要ない。

暗黙の型変換抑止

explicit宣言されていないコンストラクタを持つクラスは、 下記のコードのように暗黙の型変換が起こる。

    //  example/term_explanation/explicit_ut.cpp 10

    struct A {
        A(int a) : x{a} {}
        int x;
    };

    A f(A a) { return a; };
    //  example/term_explanation/explicit_ut.cpp 21

    A a = 1;  // A::Aがexplicitでないため、iはA{1}に変換される
    ASSERT_EQ(a.x, 1);

    auto b = f(2);  // A::Aがexplicitでないため、2はA{2}に変換される
    ASSERT_EQ(b.x, 2);

暗黙の型変換はわかりづらいバグを生み出してしまうことがあるため、 下記のように適切にexplicitを使うことで、このような変換を抑止することができる。

    //  example/term_explanation/explicit_ut.cpp 34

    struct A {
        explicit A(int a) : x{a} {}  // 暗黙の型変換の抑止
        int x;
    };

    A f(A a) { return a; };
    //  example/term_explanation/explicit_ut.cpp 45

    // A a = 1;    // A::Aがexplicitであるため、コンパイルエラー
    // auto b = f(2);  // A::Aがexplicitであるため、コンパイルエラー

C++03までは、一様初期化がサポートされていなかったため、 explicitは単一引数のコンストラクタに使用されることが一般的であった。

C++11からサポートされた一様初期化を下記のように使用することで、 暗黙の型変換を使用できる。

    //  example/term_explanation/explicit_ut.cpp 56

    struct A {
        A(int a, int b) : x{a}, y{b} {}
        int x;
        int y;
    };

    A    f(A a) { return a; };
    bool operator==(A lhs, A rhs) { return std::tuple(lhs.x, lhs.x) == std::tuple(rhs.x, rhs.x); }
    //  example/term_explanation/explicit_ut.cpp 70

    A a = {1, 2};  // A::Aがexplicitでないため、iはA{1, 2}に変換される
    ASSERT_EQ(a, (A{1, 2}));

    auto b = f({2, 1});  // A::Aがexplicitでないため、2はA{2,1}に変換される
    ASSERT_EQ(b, (A{2, 1}));

以下に示す通り、コンストラクタの引数の数によらず、 C++11からは暗黙の型変換を抑止したい型のコンストラクタにはexplicit宣言することが一般的となっている。

    //  example/term_explanation/explicit_ut.cpp 82

    struct A {
        explicit A(int a, int b) : x{a}, y{b} {}
        int x;
        int y;
    };

    A    f(A a) { return a; };
    bool operator==(A lhs, A rhs) { return std::tuple(lhs.x, lhs.x) == std::tuple(rhs.x, rhs.x); }
    //  example/term_explanation/explicit_ut.cpp 96

    // A a = {1, 2};  // A::Aがexplicitであるため、コンパイルエラー
    // auto b = f({2, 1});  // A::Aがexplicitであるため、コンパイルエラー

explicit type operator()

型変換演算子のオーバーロードの戻り値をさらに別の型に変換すると、 きわめてわかりづらいバグを生み出してしまうことがあるため、 この機能を使用すると型変換演算子のオーバーロードの型変換の抑止することができる。

    //  example/term_explanation/explicit_ut.cpp 110

    struct A {
        explicit A(int a) : x{a} {}  // 暗黙の型変換の抑止
        operator bool() const noexcept { return x; }
        int x;
    };
    //  example/term_explanation/explicit_ut.cpp 123

    auto a = A{2};

    ASSERT_TRUE(a);
    ASSERT_EQ(1, a);  // aをboolに変換するとtrue、trueをintに変換すると1

    int b = a + 1;  // aをboolに変換するとtrue、trueをintに変換すると1であるため、bは2
    ASSERT_EQ(b, 2);

以下に示すようにexplicitを使うことで、このような暗黙の型変換を抑止できる。

    //  example/term_explanation/explicit_ut.cpp 137

    struct A {
        explicit A(int a) : x{a} {}  // 暗黙の型変換の抑止
        explicit operator bool() const noexcept { return x; }// 暗黙の型変換の抑止
        int x;
    };
    //  example/term_explanation/explicit_ut.cpp 150

    auto a = A{2};

    // ASSERT_EQ(1, a);  // operator boolがexplicitであるため、コンパイルエラー
    // int b = a + 1;  // operator boolがexplicitであるため、コンパイルエラー

explicit(COND)

C++20から導入されたexplicit(COND)は、 コンストラクタや変換演算子に対して、 特定の条件下で暗黙の型変換を許可または禁止する機能である。 CONDには、型特性や定数式などの任意のconstexprな条件式を指定できる。 以下にこのシンタックスの単純な使用例を示す。

    //  example/term_explanation/explicit_ut.cpp 162

    template <typename T>  // Tが整数型の場合、暗黙の型変換を許可
    struct S {
    #if __cplusplus >= 202002L  // c++20
        explicit(!std::is_integral_v<T>) S(T x) : value{x} {}

    #else  // c++17
        // T が整数型でない場合に有効なコンストラクタ
        template <typename U = T, std::enable_if_t<!std::is_integral_v<U>>* = nullptr>
        explicit S(U x) : value{x} { }

        // T が整数型の場合に有効な非explicitコンストラクタ
        // T が整数型の場合に有効な非explicitコンストラクタ
        template <typename U = T, std::enable_if_t<std::is_integral_v<U>>* = nullptr>
        S(U x) : value{x} { }
    #endif

        T value;
    };

    template <typename T>  // 推論ガイド
    S(T)->S<T>;
    //  example/term_explanation/explicit_ut.cpp 190

    S s = 1;      // Tがintであるため、explicit宣言されていないため、暗黙の型変換は許可
    // S t = 1.0; // Tが整数型でないため暗黙の型変換は禁止であるため、コンパイルエラー
    S t{1.0};     // Tが整数型でないが、明示的な初期化は問題ない

    ASSERT_EQ(s.value, 1);

テンプレートのパラメータの型による暗黙の型変換の可否をコントロールする例を以下に示す。

    //  example/term_explanation/explicit_ut.cpp 203

    template <typename T>
    struct Optional {
    #if __cplusplus >= 202002L  // c++20
        explicit(std::is_same_v<T, std::nullptr_t>) Optional(const T& value)
            : has_value_(!std::is_same_v<T, std::nullptr_t>), value_(value) { }

    #else  // c++17
        // Tがnullptr_tではない場合に有効なコンストラクタ
        template <typename U = T, std::enable_if_t<!std::is_same_v<U, std::nullptr_t>>* = nullptr>
        Optional(const U& value) : has_value_(true), value_(value) { }

        // Tがnullptr_tの場合に有効なexplicitコンストラクタ
        template <typename U = T, std::enable_if_t<std::is_same_v<U, std::nullptr_t>>* = nullptr>
        explicit Optional(const U& value) : has_value_(false), value_(value) { }
    #endif

        explicit operator bool() const noexcept { return has_value_; }  // bool型への変換
                 operator T() const noexcept { return value_; }         // T型への変換

    private:
        bool has_value_;
        T    value_;
    };
    template <typename T>  // 推論ガイド
    Optional(T)->Optional<T>;
    //  example/term_explanation/explicit_ut.cpp 235

    Optional a = 2;   // T == intであるため、暗黙の型変換を許可
    ASSERT_TRUE(a);   // has_value_がtrueであるため
    ASSERT_EQ(a, 2);  // T型への暗黙的変換をチェック

    // Optional n = nullptr; // T == std::nullptr_tのため暗黙の型変換抑止により、コンパイルエラー
    Optional n{nullptr};  // 通常の初期化
    ASSERT_FALSE(n);

こういった工夫により、コードの過度な柔軟性を適度に保つことができ、 可読性の向上につながる。

expressionと値カテゴリ

ここでは、expression(式)の値カテゴリや、それに付随した機能についての解説を行う。

expression

expression(式)とは、 「演算子とそのオペランドの並び」である(オペランドのみの記述も式である)。 演算子とは以下のようなものである。

expressionは、

に分類される。

expressionは、lvaluervalueである。

lvalue

lvalueとは、

T const&は代入式の左辺になりは得ないがlvalueである。rvalueリファレンスもlvalueである。

rvalue

rvalueとは、

rvalueリファレンス(T&&型の変数)はlvalueである。 一方、その初期化に使われる式(例えばstd::move(x))はxvalueである。

xvalue

xvalueとは以下のようなものである。

prvalue

prvalueとは、オブジェクトやビットフィールドを初期化する、 もしくはオペランドの値を計算する式であり、以下のようなものである。

つまり、prvalueとはいわゆるテンポラリオブジェクトのことである(下記のstd::string{}で作られるようなオブジェクト)。 多くの場合、prvalueはテンポラリオブジェクトを生成するが、 C++17以降はRVO(Return Value Optimization)により、 テンポラリオブジェクトを生成せず、直接、初期化に使われる場合もある。
また、正確にはprvalueと呼ぶべき場面でも単にrvalueと呼ばれることがある。 このドキュメントでも、そうなっていることもある。

    //  example/term_explanation/rvalue_lvalue_ut.cpp 10
    // str0を初期化するためにstd::string{}により生成されるオブジェクトはprvalue、 str0はlvalue
    //   ↓lvalue
    auto str0 = std::string{};  // この式の左辺はテンポラリオブジェクト(つまりprvalue)

    /*
    auto* str0_ptr = &std::string{};  // prvalueのアドレスの取得はできない
    ↑は、メッセージは error: taking address of rvalue でコンパイルエラー */

    /*
    std::string& str1_ref = std::string{};  // prvalueを非constなlvalueリファレンスではバインドできない
    ↑は、コンパイルエラーで、エラーメッセージは error: taking address of rvalue */

    std::string const& str2_ref = std::string{};  // prvalueはconstなlvalueリファレンスでバインドできる
    // ↓のようにすればアドレスを取得できるが、このようなことはすべきではない。
    std::string const* str2_ptr = &str2_ref;  // str_ptrはprvalueのアドレスを指しているが、、、

    auto&& str3_ref = std::string{};  // prvalueはprvalueリファレンスでバインドできる
    // ↓のようにすればアドレスを取得できるが、このようなことはすべきではない。
    std::string* str3_ptr = &str3_ref;  // str_ptrはprvalueのアドレスを指しているが、、、

glvalue

glvalueは、

オブジェクトや関数を参照する式を総称してglvalueと呼ぶ。 これにより、式が「場所を指す」か「一時的な値を表す」かを大きく分類できる。

decltypeとexpression

エッセンシャルタイプがTであるlvalue、xvalue、prvalueに対して (例えば、std::string const&のエッセンシャルタイプはstd::stringである)、 decltypeの算出結果は下表のようになる。

decltype 算出された型
decltype(lvalue) T
decltype((lvalue)) T&
decltype(xvalue) T&&
decltype((xvalue)) T&&
decltype(prvalue) T
decltype((prvalue)) T

この表の結果を使用した下記の関数型マクロ群により式を分類できる。 定義から明らかな通り、これらは テンプレートメタプログラミング に有効に活用できる。

    //  example/term_explanation/decltype_expression_ut.cpp 7

    #define IS_LVALUE(EXPR_) std::is_lvalue_reference_v<decltype((EXPR_))>
    #define IS_XVALUE(EXPR_) std::is_rvalue_reference_v<decltype((EXPR_))>
    #define IS_PRVALUE(EXPR_) !std::is_reference_v<decltype((EXPR_))>
    #define IS_RVALUE(EXPR_) (IS_PRVALUE(EXPR_) || IS_XVALUE(EXPR_))

    auto str = std::string{};

    static_assert(IS_LVALUE(str), "EXPR_ must be lvalue");
    static_assert(!IS_RVALUE(str), "EXPR_ must NOT be rvalue");

    static_assert(IS_XVALUE(std::move(str)), "EXPR_ must be xvalue");
    static_assert(!IS_PRVALUE(std::move(str)), "EXPR_ must NOT be prvalue");

    static_assert(IS_PRVALUE(std::string{}), "EXPR_ must be prvalue");
    static_assert(IS_RVALUE(std::string{}), "EXPR_ must be rvalue");
    static_assert(!IS_LVALUE(std::string{}), "EXPR_ must NOT be lvalue");

リファレンス

リファレンス(参照)とは、以下のいずれか、もしくはすべてを指すが、 単にリファレンスと呼ぶ場合、lvalueリファレンスを指すことが多い。

これらの概念と関わり強い、リファレンスcollapsingについても併せて解説を行う。

lvalueリファレンス

lvalueリファレンスとは、

    //  example/term_explanation/rvalue_lvalue_ut.cpp 40

    int  a     = 0;
    int& a_ref = a;  // a_refはaのリファレンス
                     // a_refはaをバインドする

    ASSERT_EQ(&a, &a_ref);  // リファレンスは別名に過ぎないため、このテストが成立

    int b = 1;
    a_ref = b;  // 一見、a_refの再初期化に見えるが、実際は値の代入になるため、以下のテストが成立
    ASSERT_EQ(a, b);  // リファレンスは別名に過ぎないため、このテストが成立

    /*
    int& t_ref = int{99};  非const lvalueリファレンスはrvalueをバインドできない */
    int const& t_ref = int{99};  // 上記とは異なり、const lvalueリファレンスはrvalueをバインドできる
    ASSERT_EQ(t_ref, 99);

このようなリファレンスのバインドの可否はオーバーロードにも影響を与える。

    //  example/term_explanation/rvalue_lvalue_ut.cpp 60

    int f(int& )        { return 1; }   // f-1
    int f(int const & ) { return 2; }   // f-2
    //  example/term_explanation/rvalue_lvalue_ut.cpp 69

    int       a = 0;
    int const b = 0;

    ASSERT_EQ(1, f(a));  // f(a)は、f-2も呼び出せるが、デフォルトでは、f-1が呼ばれる
    ASSERT_EQ(2, f(static_cast<int const&>(a)));  // aをconstにキャストして、強制的にf-2の呼び出し
    ASSERT_EQ(2, f(b));                           // constオブジェクトのバインド
    ASSERT_EQ(2, f(int{}));                       // rvalueのバインド

rvalueリファレンス

rvalueリファレンスは、

    //  example/term_explanation/rvalue_lvalue_ut.cpp 86

    int        a      = 0;
    int const& a_ref0 = a;        // const lvalueリファレンス
    int const& a_ref1 = int(99);  // const lvalueリファレンスはrvalueをバインドできる
    int&& a_ref2 = int(99);  // rvalueリファレンスはテンポラリオブジェクトをバインドできる

    ASSERT_EQ(a_ref1, 99);
    ASSERT_EQ(a_ref2, 99);

このようなリファレンスのバインドの可否はオーバーロードにも影響を与える。

    //  example/term_explanation/rvalue_lvalue_ut.cpp 99
    }  // namespace ref_pattern2

    namespace ref_pattern3 {
    int f(int&)       { return 1; } // f-1
    int f(int const&) { return 2; } // f-2
    int f(int&&)      { return 3; } // f-3
    //  example/term_explanation/rvalue_lvalue_ut.cpp 112

    int       a = 0;
    int const b = 0;

    ASSERT_EQ(1, f(a));      // f-1の呼び出し
    ASSERT_EQ(2, f(b));      // f-2の呼び出し、constなlvalueリファレンスのバインド
    ASSERT_EQ(3, f(int{}));  // f-3の呼び出し、f-3が無ければ、f-2を呼び出すが
    ASSERT_EQ(2, f(static_cast<int const&>(a)));  // strをconstリファレンスにキャストして、強制的にf-2の呼び出し
    ASSERT_EQ(3, f(static_cast<int&&>(a)));       // strをrvalueリファレンスにキャストして、 強制的にf-3の呼び出し
    ASSERT_EQ(3, f(std::move(a)));                // f-3の呼び出し

C++11でrvalueの概念の整理やrvalueリファレンス、 std::move()の導入が行われた目的はプログラム実行速度の向上である。 以下のパターンの代入式の処理がどのように違うのかを見ることでrvalueやstd::moveの効果について説明する。

lvalueからの代入

下記コードにより「lvalueからの代入」を説明する。

    //  example/term_explanation/rvalue_move_ut.cpp 10

    auto str0 = std::string{};        // 行1   str0はlvalue
    auto str1 = std::string{"hehe"};  // 行2   str1もlvalue
    str0      = str1;                 // 行3   lvalueからの代入

rvalueからの代入

下記コードにより「rvalueからの代入」を説明する。

    //  example/term_explanation/rvalue_move_ut.cpp 23

    auto str0 = std::string{};        // 行1   str0はlvalue
    str0      = std::string{"hehe"};  // 行2   rvalueからの代入
                                      // 行3   行2で生成されたテンポラリオブジェクト(rvalue)は解放

std::move(lvalue)からの代入

下記コードにより「std::move(lvalue)からの代入」を説明する。

    //  example/term_explanation/rvalue_move_ut.cpp 36

    auto str0 = std::string{};        // 行1   str0はlvalue
    auto str1 = std::string{"hehe"};  // 行2   str1もlvalue
    str0      = std::move(str1);      // 行3   str1への代入以外のアクセスは未規定である。

forwardingリファレンス

関数テンプレートの型パラメータTに対してT&&として宣言された仮引数、 または型推論を伴うauto&&として宣言された変数を、forwardingリファレンスと呼ぶ (この概念はC++14から存在し、慣用的にユニバーサルリファレンスと呼ばれていたが、 C++17から正式にforwardingリファレンスと命名された)。 forwardingリファレンスは一見rvalueリファレンスのように見えるが、 下記に示す通り、lvalueにもrvalueにもバインドできる (リファレンスcollapsingにより、このようなバインドが可能になる)。

    //  example/term_explanation/universal_ref_ut.cpp 8

    template <typename T>
    void f(T&& t) noexcept  // tはforwardingリファレンス
    {
        // ...
    }

    template <typename T>
    void g(std::vector<T>&& t) noexcept  // tはrvalueリファレンス
    {
        // ...
    }
    //  example/term_explanation/universal_ref_ut.cpp 29

    auto       vec  = std::vector<std::string>{"lvalue"};   // vecはlvalue
    auto const cvec = std::vector<std::string>{"clvalue"};  // cvecはconstなlvalue

    f(vec);                                 // 引数はlvalue
    f(cvec);                                // 引数はconstなlvalue
    f(std::vector<std::string>{"rvalue"});  // 引数はrvalue

    // g(vec);  // 引数がlvalueなのでコンパイルエラー
    // g(cvec); // 引数がconst lvalueなのでコンパイルエラー
    g(std::vector<std::string>{"rvalue"});  // 引数はrvalue

下記のコードはジェネリックラムダの引数をforwardingリファレンスにした例である。

    //  example/term_explanation/universal_ref_ut.cpp 47

    // sはforwardingリファレンス
    auto value_type = [](auto&& s) noexcept {
        if (std::is_same_v<std::string&, decltype(s)>) {
            return 0;
        }
        if (std::is_same_v<std::string const&, decltype(s)>) {
            return 1;
        }
        if (std::is_same_v<std::string&&, decltype(s)>) {
            return 2;
        }
        return 3;
    };

    auto       str  = std::string{"lvalue"};
    auto const cstr = std::string{"const lvalue"};

    ASSERT_EQ(0, value_type(str));
    ASSERT_EQ(1, value_type(cstr));
    ASSERT_EQ(2, value_type(std::string{"rvalue"}));

通常、forwardingリファレンスはstd::forwardと組み合わせて使用される。

ユニバーサルリファレンス

ユニバーサルリファレンスとは、「forwardingリファレンス」の通称、もしくは旧称である。

perfect forwarding

perfect forwarding(完全転送)とは、引数のrvalue性や lvalue性を損失することなく、 その引数を別の関数に転送する技術のことを指す。 通常は、forwardingリファレンスである関数の仮引数をstd::forwardを用いて、 他の関数に渡すことで実現される。

perfect forwardingの使用例を以下に示す。

    //  example/term_explanation/perfect_forwarding_ut.cpp 7

    class Widget {
    public:
        explicit Widget(std::string const& name) : name_{name} {}        // lvalueによるコンストラクタ
        explicit Widget(std::string&& name) : name_{std::move(name)} {}  // rvalueによるコンストラクタ
        std::string const& GetName() const { return name_; }

    private:
        std::string name_;  // コンストラクタの引数をcopy/move構築
    };

    template <typename T>
    Widget make_Widget(T&& str)
    {                                         // strはforwardingリファレンス
        return Widget(std::forward<T>(str));  // perfect forwarding
    }
    //  example/term_explanation/perfect_forwarding_ut.cpp 28

    std::string       str{"lvalue ref"};
    std::string const cstr{"lvalue const ref"};

    Widget w0 = make_Widget(str);  // make_Widget -> Widget(std::string const&)
    ASSERT_EQ(w0.GetName(), str);

    Widget w1 = make_Widget(cstr);  // make_Widget -> Widget(std::string const&)
    ASSERT_EQ(w1.GetName(), cstr);

    Widget w2 = make_Widget(std::string{"rvalue ref"});  // make_Widget -> Widget(std::string &&)
    ASSERT_EQ(w2.GetName(), "rvalue ref");

    Widget w3 = make_Widget(std::move(str));  // make_Widget -> Widget(std::string &&)
    ASSERT_EQ(w3.GetName(), "lvalue ref");    // strはムーブされたのでアクセス不可

リファレンスcollapsing

Tを任意の型とし、TRを下記のように宣言した場合、

    using TR = T&;

下記のようなコードは、C++03ではコンパイルエラーとなったが、 C++11からはエラーとならず、TRRはT&となる。

    using TRR = TR&;

2つの&を1つに折り畳む、このような機能をリファレンスcollapsingと呼ぶ。

下記はTをintとした場合のリファレンスcollapsingの動きを示している。

    //  example/term_explanation/ref_collapsing_ut.cpp 7

    int i;

    using IR  = int&;
    using IRR = IR&;  // IRRはint& &となり、int&に変換される

    IR  ir  = i;
    IRR irr = ir;

    static_assert(std::is_same_v<int&, decltype(ir)>);   // lvalueリファレンス
    static_assert(std::is_same_v<int&, decltype(irr)>);  // lvalueリファレンス

リファレンスcollapsingは、型エイリアス、型であるテンプレートパラメータ、decltypeに対して行われる。 詳細な変換則は、下記のようになる。

    T& &   -> T&
    T& &&  -> T&
    T&& &  -> T&
    T&& && -> T&&

下記のようなクラステンプレートを定義した場合、

    //  example/term_explanation/ref_collapsing_ut.cpp 26

    template <typename T>
    struct Ref {
        T&  t;
        T&& u;
    };

下記のコードにより、テンプレートパラメータに対するこの変換則を確かめることができる。

    //  example/term_explanation/ref_collapsing_ut.cpp 38

    static_assert(std::is_same_v<int&, decltype(Ref<int>::t)>);    // lvalueリファレンス
    static_assert(std::is_same_v<int&&, decltype(Ref<int>::u)>);   // rvalueリファレンス

    static_assert(std::is_same_v<int&, decltype(Ref<int&>::t)>);   // lvalueリファレンス
    static_assert(std::is_same_v<int&, decltype(Ref<int&>::u)>);   // lvalueリファレンス

    static_assert(std::is_same_v<int&, decltype(Ref<int&&>::t)>);  // lvalueリファレンス
    static_assert(std::is_same_v<int&&, decltype(Ref<int&&>::u)>); // rvalueリファレンス

この機能がないC++03では、

    //  example/term_explanation/ref_collapsing_ut.cpp 52

    template <typename T>
    struct AddRef {
        using type = T&;
    };

ようなクラステンプレートに下記コードのようにリファレンス型を渡すとコンパイルエラーとなる。

    //  example/term_explanation/ref_collapsing_ut.cpp 69

    static_assert(std::is_same_v<int&, AddRef<int&>::type>);

この問題を回避するためには下記のようなテンプレートの特殊化が必要になる。

    //  example/term_explanation/ref_collapsing_ut.cpp 59

    template <typename T>
    struct AddRef<T&> {
        using type = T&;
    };

上記したようなクラステンプレートでのメンバエイリアスの宣言は、 テンプレートメタプログラミング で頻繁に使用されるため、 このようなテンプレートの特殊化を不要にするリファレンスcollapsingは、 有用な機能拡張であると言える。

danglingリファレンス

Dangling リファレンスとは、破棄後のオブジェクトを指しているリファレンスを指す。 このようなリファレンスにアクセスすると、未定義動作に繋がるに繋がる。

    //  example/term_explanation/dangling_ut.cpp 9

    bool X_destructed;
    class X {
    public:
        X() { X_destructed = false; }
        ~X() { X_destructed = true; }
    };

    bool A_destructed;
    class A {
    public:
        A() { A_destructed = false; }
        ~A() { A_destructed = true; }

        X const& GetX() const noexcept { return x_; }

    private:
        X x_;
    };

    //  example/term_explanation/dangling_ut.cpp 34

    auto a = A{};

    auto const& x_safe = a.GetX();  // x_safeはダングリングリファレンスではない
    ASSERT_FALSE(A_destructed || X_destructed);

    auto const& x_dangling = A{}.GetX();  // 次の行でxが指すオブジェクトは解放される
    // この行ではxはdangngling リファレンスになる。
    ASSERT_TRUE(A_destructed && X_destructed);

    auto const* x_ptr_dangling = &A{}.GetX();  // 次の行でxが指すオブジェクトは解放される
    // この行ではxはdangngling ポインタになる。
    ASSERT_TRUE(A_destructed && X_destructed);

danglingポインタ

danglingポインタとは、danglingリファレンスと同じような状態になったポインタを指す。

リファレンス修飾

rvalue修飾lvalue修飾とを併せて、リファレンス修飾と呼ぶ。

rvalue修飾

下記GetString0()のような関数が返すオブジェクトの内部メンバに対するハンドルは、 オブジェクトのライフタイム終了後にもアクセスすることができるため、 そのハンドルを通じて、 ライフタイム終了後のオブジェクトのメンバオブジェクトにもアクセスできてしまう。

ライフタイム終了後のオブジェクトにアクセスすることは未定義動作であり、 特にそのオブジェクトがrvalueであった場合、さらにその危険性は高まる。

こういったコードに対処するためのシンタックスが、lvalue修飾、rvalue修飾である。

下記GetString1()、GetString3()、GetString4()のようにメンバ関数をlvalue修飾やrvalue修飾することで、 rvalueの内部ハンドルを返さないようにすることが可能となり、上記の危険性を緩和することができる。

    //  example/term_explanation/ref_qualifiers_ut.cpp 8

    class C {
    public:
        explicit C(char const* str) : str_{str} {}

        // lvalue修飾なし、rvalue修飾なし
        std::string& GetString0() noexcept { return str_; }

        // lvalue修飾
        std::string const& GetString1() const& noexcept { return str_; }

        // rvalue修飾
        // *thisがrvalueの場合でのGetString1()の呼び出しは、この関数を呼び出すため、
        // class内部のハンドルを返してはならない。
        // また、それによりstd::stringを生成するため、noexcept指定してはならない。
        std::string GetString1() const&& { return str_; }

        // lvalue修飾だが、const関数はrvalueからでも呼び出せる。
        // rvalueに対しての呼び出しを禁止したい場合には、GetString4のようにする。
        std::string const& GetString2() const& noexcept { return str_; }

        // lvalue修飾
        // 非constなのでrvalueからは呼び出せない。
        std::string const& GetString3() & noexcept { return str_; }

        // lvalue修飾
        std::string const& GetString4() const& noexcept { return str_; }

        // rvalue修飾
        // rvalueからこの関数を呼び出されるとrvalueオブジェクトの内部ハンドルを返してしまい、
        // 危険なので=deleteすべき。
        std::string const& GetString4() const&& = delete;

    private:
        std::string str_;
    };
    //  example/term_explanation/ref_qualifiers_ut.cpp 49

    auto        c    = C{"c0"};
    auto const& s0_0 = c.GetString0();        // OK cが解放されるまでs0_0は有効
    auto        s0_1 = C{"c1"}.GetString0();  // NG 危険なコード
    // s0_1が指すオブジェクトは、次の行で無効になる

    auto const& s1_0 = c.GetString1();        // OK GetString1()&が呼び出される
    auto const& s1_1 = C{"c1"}.GetString1();  // OK GetString1()&&が呼び出される
    // s1_0が指すrvalueはs1_0がスコープアウトするまで有効

    auto const& s2_0 = c.GetString2();        // OK GetString2()&が呼び出される
    auto const& s2_1 = C{"c1"}.GetString2();  // NG const関数はlvalue修飾しても呼び出し可能
    // s2_1が指すオブジェクトは、次の行で無効になる

    auto const& s3_0 = c.GetString3();  // OK GetString3()&が呼び出される
    // auto const& s3_1 = C{"c1"}.GetString3();  // 危険なのでコンパイルさせない

    auto const& s4_0 = c.GetString4();  // OK GetString4()&が呼び出される
    // auto const& s4_1 = C{"c1"}.GetString4();  // 危険なのでコンパイルさせない

lvalue修飾

rvalue修飾を参照せよ。

エクセプション安全性の保証

関数のエクセプション発生時の安全性の保証には以下の3つのレベルが規定されている。

no-fail保証

「no-fail保証」を満たす関数はエクセプションをthrowしない。 no-failを保証する関数は、 noexceptを使用してエクセプションを発生させないことを明示できる。

標準テンプレートクラスのパラメータとして使用するクラスのメンバ関数には、 正確にnoexceptの宣言をしないと、 テンプレートクラスのメンバ関数によってはパフォーマンスを起こしてしまう可能性がある。

強い安全性の保証

「強い保証」を満たす関数は、この関数がエクセプションによりスコープから外れた場合でも、 この関数が呼ばれなかった状態と同じ(プログラムカウンタ以外の状態は同じ)であることを保証する。 従って、この関数呼び出しは成功したか、完全な無効だったかのどちらかになる。

基本的な安全性の保証

「基本的な安全性の保証」を満たす関数は、この関数がエクセプションによりスコープから外れた場合でも、 メモリ等のリソースリークは起こさず、 オブジェクトは(変更されたかもしれないが)引き続き使えることを保証する。

noexcept

C++11で導入されたnoexceptキーワードには、以下の2つの意味がある。

以下に上記のコード例を示す。

    //  example/term_explanation/noexcept_ut.cpp 11

    std::string f_noexcept() noexcept  // エクセプションを発生させない
    {
        return "No exceptions here!";
    }

    std::string f_except() noexcept(false)  // エクセプションを発生させる
    {
        throw std::runtime_error{"always throw"};

        return "No exceptions here!";
    }

    // noexcept or noexcept(false)と宣言しない限りnoexceptでない
    std::string f_except2()  // エクセプションを発生させる
    {
        throw std::runtime_error{"always throw"};

        return "No exceptions here!";
    }
    //  example/term_explanation/noexcept_ut.cpp 37

    static_assert(noexcept(f_noexcept()));  // エクセプションを発生させる可能性の確認
    static_assert(!noexcept(f_except()));   // エクセプションを発生させない可能性の確認
    static_assert(!noexcept(f_except2()));  // エクセプションを発生させない可能性の確認

    ASSERT_EQ(f_noexcept(), "No exceptions here!");  // 動作確認
    ASSERT_THROW(f_except(), std::runtime_error);    // エクセプションの発生確認
    ASSERT_THROW(f_except2(), std::runtime_error);   // エクセプションの発生確認

演算子としてのnoexceptはテンプレートで頻繁に使用されるため、以下にそのような例を示す。

    //  example/term_explanation/noexcept_ut.cpp 50

    class PossiblyThrow {  // オブジェクト生成でエクセプションの発生可能性あり
    public:
        PossiblyThrow() {}
    };

    // テンプレート型Tがnoexceptで生成可能なら、関数もnoexceptにする
    template <typename T>
    void t_f(T const&) noexcept(std::is_nothrow_constructible_v<T>)
    {
        // Tを生成して、何らかの処理を行う
    }
    //  example/term_explanation/noexcept_ut.cpp 67

    auto i = int{};
    auto p = PossiblyThrow{};

    static_assert(!std::is_nothrow_constructible_v<PossiblyThrow>);
    static_assert(std::is_nothrow_constructible_v<decltype(i)>);
    static_assert(noexcept(t_f(i)));
    static_assert(!noexcept(t_f(p)));

exception-unfriendly

以下のような関数

の呼び出しでエクセプションがthrowされると、未定義動作未規定動作が発生するため、 exception-unfriendly(エクセプションに不向き)であるとされる。 従って上記の関数は暗黙的または明示的にnoexceptであることが求められる。

シンタックス、セマンティクス

直訳すれば、シンタックスとは構文論のことであり、セマンティクスとは意味論のことである。 この二つの概念の違いをはっきりと際立たせる有名な文を例示する。

    Colorless green ideas sleep furiously(直訳:無色の緑の考えが猛烈に眠る)

この文は構文的には正しい(シンタックスは問題ない)が、 意味不明である(セマンティクスは誤り)。

C++プログラミングにおいては、コンパイルできることがシンタックス的な正しさであり、例えば

等がセマンティクス的な正しさである。

セマンティクス的に正しいソースコードは読みやすく、保守性、拡張性に優れている。

等価性のセマンティクス

純粋数学での実数の等号(=)は、任意の実数x、y、zに対して、

意味
反射律 x = x
対称律 x = yならばy = x
推移律 x = y且つy = zならばx = z

を満たしている。x = yが成立する場合、「xはyと等しい」もしくは「xはyと同一」であると言う。

C++における組み込みの==も純粋数学の等号と同じ性質を満たしている。 下記のコードは、その性質を表している。

    //  example/term_explanation/semantics_ut.cpp 13

    auto  a = 0;
    auto& b = a;

    ASSERT_TRUE(a == b);
    ASSERT_TRUE(&a == &b);  // aとbは同一

しかし、下記のコード内のa、bは同じ値を持つが、 アドレスが異なるため同一のオブジェクトではないにもかかわらず、組み込みの==の値はtrueとなる。

    //  example/term_explanation/semantics_ut.cpp 23

    auto a = 0;
    auto b = 0;

    ASSERT_TRUE(a == b);
    ASSERT_FALSE(&a == &b);  // aとbは同一ではない

このような場合、aとbは等価であるという。同一ならば等価であるが、等価であっても同一とは限らない。

ポインタや配列をオペランドとする場合を除き、C++における組み込みの==は、 数学の等号とは違い、等価を表していると考えられるが、 上記した3つの律を守っている。従ってオーバーロードoperator==も同じ性質を守る必要がある。

組み込みの==やオーバーロード==演算子のこのような性質をここでは「等価性のセマンティクス」と呼ぶ。

クラスAを下記のように定義し、

    //  example/term_explanation/semantics_ut.cpp 34

    class A {
    public:
        explicit A(int num, char const* name) noexcept : num_{num}, name_{name} {}

        int         GetNum() const noexcept { return num_; }
        char const* GetName() const noexcept { return name_; }

    private:
        int const   num_;
        char const* name_;
    };

そのoperator==を下記のように定義した場合、

    //  example/term_explanation/semantics_ut.cpp 51

    inline bool operator==(A const& lhs, A const& rhs) noexcept
    {
        return std::tuple(lhs.GetNum(), lhs.GetName()) == std::tuple(rhs.GetNum(), rhs.GetName());
    }

単体テストは下記のように書けるだろう。

    //  example/term_explanation/semantics_ut.cpp 62

    auto a0 = A{0, "a"};
    auto a1 = A{0, "a"};

    ASSERT_TRUE(a0 == a1);

これは、一応パスするが(処理系定義の動作を前提とするため、必ず動作する保証はない)、 下記のようにすると、パスしなくなる。

    //  example/term_explanation/semantics_ut.cpp 72

    char a0_name[] = "a";
    auto a0        = A{0, a0_name};

    char a1_name[] = "a";
    auto a1        = A{0, a1_name};

    ASSERT_TRUE(a0 == a1);  // テストが失敗する

一般にポインタの等価性は、その値の同一性ではなく、 そのポインタが指すオブジェクトの等価性で判断されるべきであるが、 先に示したoperator==はその考慮をしていないため、このような結果になった。

次に、これを修正した例を示す。

    //  example/term_explanation/semantics_ut.cpp 91

    inline bool operator==(A const& lhs, A const& rhs) noexcept
    {
        return std::tuple(lhs.GetNum(), std::string_view{lhs.GetName()})
               == std::tuple(rhs.GetNum(), std::string_view{rhs.GetName()});
    }

ポインタをメンバに持つクラスのoperator==については、上記したような処理が必要となる。

次に示す例は、基底クラスBaseとそのoperator==である。

    //  example/term_explanation/semantics_ut.cpp 114

    class Base {
    public:
        explicit Base(int b) noexcept : b_{b} {}
        virtual ~Base() = default;
        int GetB() const noexcept { return b_; }

    private:
        int b_;
    };

    inline bool operator==(Base const& lhs, Base const& rhs) noexcept { return lhs.GetB() == rhs.GetB(); }

次の単体テストが示す通り、これ自体には問題がないように見える。

    //  example/term_explanation/semantics_ut.cpp 131

    auto b0 = Base{0};
    auto b1 = Base{0};
    auto b2 = Base{1};

    ASSERT_TRUE(b0 == b0);
    ASSERT_TRUE(b0 == b1);
    ASSERT_FALSE(b0 == b2);

しかし、Baseから派生したクラスDerivedを

    //  example/term_explanation/semantics_ut.cpp 143

    class Derived : public Base {
    public:
        explicit Derived(int d) noexcept : Base{0}, d_{d} {}
        int GetD() const noexcept { return d_; }

    private:
        int d_;
    };

のように定義すると、下記の単体テストで示す通り、等価性のセマンティクスが破壊される。

    //  example/term_explanation/semantics_ut.cpp 157

    {
        auto b = Base{0};
        auto d = Derived{1};

        ASSERT_TRUE(b == d);  // NG bとdは明らかに等価でない
    }
    {
        auto d0 = Derived{0};
        auto d1 = Derived{1};

        ASSERT_TRUE(d0 == d1);  // NG d0とd1は明らかに等価ではない
    }

Derived用のoperator==を

    //  example/term_explanation/semantics_ut.cpp 174

    bool operator==(Derived const& lhs, Derived const& rhs) noexcept
    {
        return std::tuple(lhs.GetB(), lhs.GetD()) == std::tuple(rhs.GetB(), rhs.GetD());
    }

と定義しても、下記に示す通り部分的な効果しかない。

    //  example/term_explanation/semantics_ut.cpp 184

    auto d0 = Derived{0};
    auto d1 = Derived{1};

    ASSERT_FALSE(d0 == d1);  // OK operator==(Derived const&, Derived const&)の効果で正しい判定

    Base& d0_b_ref = d0;

    ASSERT_TRUE(d0_b_ref == d1);  // NG d0_b_refの実態はd0なのでd1と等価でない

この問題は、「RTTI」使った下記のようなコードで対処できる。

    //  example/term_explanation/semantics_ut.cpp 200

    class Base {
    public:
        explicit Base(int b) noexcept : b_{b} {}
        virtual ~Base() = default;
        int GetB() const noexcept { return b_; }

    protected:
        virtual bool is_equal(Base const& rhs) const noexcept { return b_ == rhs.b_; }

    private:
        int b_;

        friend inline bool operator==(Base const& lhs, Base const& rhs) noexcept
        {
            if (typeid(lhs) != typeid(rhs)) {
                return false;
            }

            return lhs.is_equal(rhs);
        }
    };

    class Derived : public Base {
    public:
        explicit Derived(int d) : Base{0}, d_{d} {}
        int GetD() const noexcept { return d_; }

    protected:
        virtual bool is_equal(Base const& rhs) const noexcept
        {
            // operator==によりrhsの型はDerivedであるため、下記のキャストは安全
            auto const& rhs_d = static_cast<Derived const&>(rhs);

            return Base::is_equal(rhs) && d_ == rhs_d.d_;
        }

    private:
        int d_;
    };

下記に示す通り、このコードは、 オープン・クローズドの原則(OCP)にも対応した柔軟な構造を実現している。

    //  example/term_explanation/semantics_ut.cpp 267

    class DerivedDerived : public Derived {
    public:
        explicit DerivedDerived(int dd) noexcept : Derived{0}, dd_{dd} {}
        int GetDD() const noexcept { return dd_; }

    protected:
        virtual bool is_equal(Base const& rhs) const noexcept
        {
            // operator==によりrhsの型はDerivedDerivedであるため、下記のキャストは安全
            auto const& rhs_d = static_cast<DerivedDerived const&>(rhs);

            return Derived::is_equal(rhs) && dd_ == rhs_d.dd_;
        }

    private:
        int dd_;
    };

前例では「両辺の型が等しいこと」が「等価であること」の必要条件となるが、 この要件が、すべてのoperator==に求められるわけではない。

次に示すのは、一見すると両辺の型が違うにもかかわらず、 等価性のセマンティクスを満たしている例である。

    //  example/term_explanation/semantics_ut.cpp 317

    auto abc = std::string{"abc"};

    ASSERT_TRUE("abc" == abc);
    ASSERT_TRUE(abc == "abc");

これは、文字列リテラルを第1引数に取るstd::stringのコンストラクタが非explicitであることによって、 文字列リテラルからstd::stringへの暗黙の型変換が起こるために成立する。

以上で見てきたように、等価性のセマンティクスを守ったoperator==の実装には多くの観点が必要になる。

copyセマンティクス

copyセマンティクスとは以下を満たすようなセマンティクスである。

従って、これらのオブジェクトに対して等価性のセマンティクス を満たすoperator==が定義されている場合、 以下を満たすようなセマンティクスであると言い換えることができる。

下記に示す通り、std::stringはcopyセマンティクスを満たしている。

    //  example/term_explanation/semantics_ut.cpp 331

    auto c_str = "string";
    auto str   = std::string{};

    str = c_str;
    ASSERT_TRUE(c_str == str);      // = 後には == が成立している
    ASSERT_STREQ("string", c_str);  // c_strの値は変わっていない

一方で、std::auto_ptrはcopyセマンティクスを満たしていない。

    //  example/term_explanation/semantics_ut.cpp 344

    std::auto_ptr<std::string> str0{new std::string{"string"}};
    std::auto_ptr<std::string> str0_pre{new std::string{"string"}};

    ASSERT_TRUE(*str0 == *str0_pre);  // 前提は成立

    std::auto_ptr<std::string> str1;

    str1 = str0;

    // ASSERT_TRUE(*str0 == *str0_pre);  // これをするとクラッシュする
    ASSERT_TRUE(str0.get() == nullptr);  // str0の値がoperator ==で変わってしまった

    ASSERT_TRUE(*str1 == *str0_pre);  // これは成立

この仕様は極めて不自然であり、std::auto_ptrはC++11で非推奨となり、C++17で規格から排除された。

下記の単体テストから明らかな通り、 「等価性のセマンティクス」で示した最後の例も、copyセマンティクスを満たしていない。

    //  example/term_explanation/semantics_ut.cpp 364

    auto b = Base{1};
    auto d = Derived{1};

    b = d;  // スライシングが起こる

    ASSERT_FALSE(b == d);  // copyセマンティクスを満たしていない

原因は、copy代入でスライシングが起こるためである。

moveセマンティクス

moveセマンティクスとは以下を満たすようなセマンティクスである(operator==が定義されていると前提)。

moveセマンティクスはcopy代入後に使用されなくなるオブジェクト(主にrvalue) からのcopy代入の実行コストを下げるために導入されたため、 下記のようなコードは推奨されない。

    //  example/term_explanation/semantics_ut.cpp 379

    class NotRecommended {
    public:
        NotRecommended(char const* name) : name_{name} {}
        std::string const& Name() const noexcept { return name_; }

        NotRecommended& operator=(NotRecommended&& rhs)  // move代入、非no-fail保証
        {
            name_ = rhs.name_;  // rhs.name_からname_へのcopy代入。パフォーマンス問題になるかも。
            return *this;
        }

    private:
        std::string name_;
    };

    bool operator==(NotRecommended const& lhs, NotRecommended const& rhs) noexcept { return lhs.Name() == rhs.Name(); }

    TEST(Semantics, move1)
    {
        auto a = NotRecommended{"a"};
        auto b = NotRecommended{"a"};

        ASSERT_EQ("a", a.Name());
        ASSERT_TRUE(a == b);

        auto c = NotRecommended{"c"};
        ASSERT_EQ("c", c.Name());

        c = std::move(a);
        ASSERT_TRUE(b == c);  // 一応、moveセマンティクスは守っているが・・・
    }

下記のコードのようにメンバの代入もできる限りmove代入を使うことで、 パフォーマンスの良い代入ができる。

    //  example/term_explanation/semantics_ut.cpp 414

    class Recommended {
    public:
        Recommended(char const* name) : name_{name} {}
        std::string const& Name() const noexcept { return name_; }

        Recommended& operator=(Recommended&& rhs) noexcept  // move代入、no-fail保証
        {
            name_ = std::move(rhs.name_);  // rhs.name_からname_へのmove代入
            return *this;
        }

    private:
        std::string name_;
    };

    bool operator==(Recommended const& lhs, Recommended const& rhs) noexcept { return lhs.Name() == rhs.Name(); }

    TEST(Semantics, move2)
    {
        auto a = Recommended{"a"};
        auto b = Recommended{"a"};

        ASSERT_EQ("a", a.Name());
        ASSERT_TRUE(a == b);

        auto c = Recommended{"c"};
        ASSERT_EQ("c", c.Name());

        c = std::move(a);     // これ以降aは使ってはならない
        ASSERT_TRUE(b == c);  // moveセマンティクスを正しく守っている
    }

MoveAssignable要件

MoveAssignable要件は、C++において型がムーブ代入をサポートするために満たすべき条件を指す。 ムーブ代入はリソースを効率的に転送する操作であり、以下の条件を満たす必要がある。

  1. リソースの移動
    ムーブ代入では、リソース(動的メモリ等)が代入元から代入先へ効率的に転送される。

  2. 有効だが未定義の状態
    ムーブ代入後、代入元のオブジェクトは有効ではあるが未定義の状態となる。 未定義の状態とは、破棄や再代入が可能である状態を指し、それ以外の操作は保証されない。

  3. 自己代入の安全性
    同一のオブジェクトをムーブ代入する場合でも、未定義動作やリソースリークを引き起こしてはならない。

  4. 効率性
    ムーブ代入は通常、コピー代入よりも効率的であることが求められる。 これは、リソースの複製を避けることで達成される(「moveセマンティクス」参照)。

  5. デフォルト実装
    ムーブ代入演算子が明示的に定義されていない場合でも、 クラスが一定の条件(例: ムーブ不可能なメンバが存在しないこと)を満たしていれば、 コンパイラがデフォルトの実装(「特殊メンバ関数」参照)を生成する。

CopyAssignable要件

CopyAssignable要件は、C++において型がコピー代入をサポートするために満たすべき条件を指す。

  1. 動作が定義されていること
    代入操作は未定義動作を引き起こしてはならない。自己代入(同じオブジェクトを代入する場合)においても正しく動作し、リソースリークを引き起こさないことが求められる。

  2. 値の保持
    代入後、代入先のオブジェクトの値は代入元のオブジェクトの値と一致していなければならない。

  3. 正しいセマンティクス
    コピー代入によって代入元のオブジェクトが変更されてはならない(「copyセマンティクス」参照)。 代入先のオブジェクトが保持していたリソース(例: メモリ)は適切に解放される必要がある。

  4. デフォルト実装
    コピー代入演算子が明示的に定義されていない場合でも、 クラスが一定の条件(例: コピー不可能なメンバが存在しないこと)を満たしていれば、 コンパイラがデフォルトの実装(「特殊メンバ関数」参照)を生成する。

C++その他

型特性キーワード

アライメントとは、 データが効率的にアクセスされるために特定のメモリアドレス境界に配置される規則である。 C++03までの規約では、アライメントのコントロールは実装依存した#pragmaなどで行っていた。

alignasalignofによりコンパイラの標準的な方法でアライメントのコントロールできるようになった。

alignof

C++11で導入されたキーワードで、型のアライメント要求を取得するために使用する。

    //  example/term_explanation/aliging_ut.cpp 12

    struct alignas(16) AlignedStruct {  // メモリ上で16バイト境界にアライメントされる
        char   a;
        double x;
        double y;
    };

    AlignedStruct a;

    uintptr_t address = reinterpret_cast<uintptr_t>(&a);  // aのアドレスを取得

    ASSERT_EQ(address % 16, 0);             // アドレスが16の倍数であることを確認
    ASSERT_EQ(alignof(AlignedStruct), 16);  // アライメントが正しいか確認

alignas

C++11で導入されたキーワードで、メモリのアライメントを指定するために使用する。

    //  example/term_explanation/aliging_ut.cpp 27

    ASSERT_EQ(alignof(long double), 16);  // アライメントが正しいか確認
    ASSERT_EQ(alignof(long long), 8);     // アライメントが正しいか確認
    ASSERT_EQ(alignof(void*), 8);         // アライメントが正しいか確認
    ASSERT_EQ(alignof(int), 4);           // アライメントが正しいか確認

addressof

addressofは、オブジェクトの「実際の」 アドレスを取得するために使用されるC++標準ライブラリのユーティリティ関数である。 通常、オブジェクトのアドレスを取得するには&演算子を使うが、 operator& がオーバーロードされている場合には、 &演算子ではオブジェクトのメモリ上の実際のアドレスを取得できない場合があり得る。 そのような場合にstd::addressofすることにより、 オーバーロードを無視して元のアドレスを確実に取得できる。

    //  example/term_explanation/aliging_ut.cpp 38

    class X {
    public:
        explicit X(int v) : v_{v} {}

        X* operator&()
        {                    // `operator&` をオーバーロードしてアドレス取得の挙動を変更
            return nullptr;  // 意図的に nullptr を返す
        }
        operator int() const noexcept { return v_; }

    private:
        int v_;
    };
    //  example/term_explanation/aliging_ut.cpp 54

    X obj{42};

    X* p0 = &obj;  // &演算子で取得するアドレス(オーバーロードされているためnullptr が返る)
    ASSERT_EQ(p0, nullptr);

    // std::addressofとほぼ同じ実装であるラムダ
    auto addressof = [](auto& arg) noexcept {
        return reinterpret_cast<std::remove_reference_t<decltype(arg)>*>(
            &const_cast<char&>(reinterpret_cast<const volatile char&>(arg)));
    };

    // ラムダaddressofを使用して強引にobjのアドレスを取得
    X* p1 = addressof(obj);
    ASSERT_NE(p1, nullptr);

    int* i_ptr = reinterpret_cast<int*>(p1);  // 処理系依存だが、通常の32/64bit環境なら通る
    ASSERT_EQ(42, *i_ptr);

    X* p2 = std::addressof(obj);
    ASSERT_EQ(p1, p2);

演算子のオペランドの評価順位

C++17で、演算子のオペランドに対する評価順序が明確に規定された。 それに対し、C++14までは、演算子のオペランド部分式の評価順序は未規定動作であった。 以下の表で示す演算子に関しては、オペランドaがオペランドbよりも先に評価される。

演算子 説明
a.b メンバアクセス演算子
a->b ポインタメンバアクセス演算子
a->*b メンバポインタアクセス演算子
a(b1, b2, b3) 関数呼び出し、引数リストの評価順序は規定外)
b @= a 代入演算子 = や複合代入演算子。@は+,-,/,&,|など
a[b] 配列アクセス
a << b ビットシフト左演算子
a >> b ビットシフト右演算子

C++11以前では、以下のコードの評価順序は未規定であったが、上記の通り定義された。

    //  example/term_explanation/etc_ut.cpp 22

    int i = 0;
    int y = (i = 1) * x + (i = 2);

    a(b1, b2, b3);  // b1, b2, b3の評価順序は規定外

関数呼び出しにおける引数の式の評価順序は、上記の例a(b1, b2, b3)での評価順序は、 不定順で序列化される。これは、b1, b2, b3 が特定の順序で評価される保証はなく、 例えば b3, b2, b1 の順に評価されたり、 b2, b3, b1 で評価される可能性があることを意味する。 一方で一度評価が開始された場合、部分式間でインターリーブ(交差実行されることはない。 つまり、b1 の評価が完全に終わる前に b2 や b3 の評価が開始されることはない。

条件演算子式condition ? expr1 : expr2については、 最初の部分であるconditionがまず評価される。 conditionの評価結果に基づき、expr1または expr2 のどちらかが選択され、選択された側だけが評価される。

    //  example/term_explanation/etc_ut.cpp 31

    int a      = 1;
    int b      = 2;
    int result = (a < b) ? func1() : func2();

なお、単項演算子のオペランドは1つであるため、優先順位の定義は不要である。

実引数/仮引数

引数(もしくは実引数、argument)、仮引数(parameter)とは下記のように定義される。

    //  example/term_explanation/argument.cpp 2

    int f0(int a, int& b) noexcept  // a, bは仮引数
    {
        // ...
    }

    void f1() noexcept
    {
        // ...

        f0(x, y);  // x, yは実引数
    }

単純代入

代入は下記のように分類される。

ill-formed

標準規格と処理系に詳しい解説があるが、

プログラムがwell-formedになった場合、そのプログラムはコンパイルできる。 プログラムがill-formedになった場合、通常はコンパイルエラーになるが、 対象がテンプレートの場合、事情は少々異なり、SFINAEによりコンパイルできることもある。

well-formed

ill-formed」を参照せよ。

未定義動作

未定義動作(Undefined Behavior)とは、 C++標準が特定の操作や状況に対して一切の制約を設けないケースである。 未定義動作が発生すると、プログラムの実行結果が予測できなくなり、 何が起こるかはコンパイラや環境によって異なる。 未定義動作を含むコードは、クラッシュやセキュリティの問題を引き起こす可能性がある。

    //  example/term_explanation/undefined_ut.cpp 14

    int a = 42;
    int b = 0;
    int c = a / b;  // 未定義動作 - ゼロ除算

    int arr[]{1, 2, 3};
    int x = arr[index];  // 未定義動作 - index>2の場合、配列範囲外アクセス

未規定動作

未規定動作(Unspecified Behavior)とは、C++標準がある操作の動作を完全には決めておらず、 複数の許容可能な選択肢がある場合でのコードの動作を指す。 未規定動作は、実装ごとに異なる可能性があり、標準は少なくとも「何らかの合理的な結果」を保証する。 つまり、動作が特定の範囲で予測可能だが、正確な挙動が処理系の実装に依存することになる。

    //  example/term_explanation/undefined_ut.cpp 35

    enum class MyEnum : int { Value1 = 1, Value2 = 256 };
    int value = static_cast<int8_t>(MyEnum::Value2);  // 未規定 - 256はint8_tとして表現できない

    auto a      = int{5};
    auto lambda = [](auto a0, auto a1) { return a0 / a1; };
    auto result = lambda(a++, a++);  // 未規定 - 引数評価の順序が決まっていない

未定義動作と未規定動作

種類 定義 結果
未定義動作 C++標準が全く保証しない動作 ゼロ除算、配列範囲外アクセス 予測不能(クラッシュなど)
未規定動作 C++標準が動作を定めていないが、いくつかの選択肢が許容されている動作 int8_t に収まらない値のキャスト 実装依存(異なるが合理的な動作)

被修飾型

被修飾型(unqualified type)とは、変数の宣言において付加される修飾子(const、 volatile など)やポインタやリファレンスなどの間接指定子を除いた素の型を指す。

修飾子(const、volatile)に注視しい場合、cv-被修飾型(cv-unqualified type)という場合もある。

例えば:

定義 被修飾型
const A& a A
volatile B& b B
const T* C C
const D d D

見た目が類似する修飾付き関数呼び出しとは無関係である。

one-definition rule

ODR」を参照せよ。

ODR

ODRとは、One Definition Ruleの略語であり、下記のようなことを定めている。

より詳しい内容がが知りたい場合は、 https://en.cppreference.com/w/cpp/language/definition が参考になる。

RVO(Return Value Optimization)

関数の戻り値がオブジェクトである場合、 戻り値オブジェクトは、その関数の呼び出し元のオブジェクトにコピーされた後、すぐに破棄される。 この「オブジェクトをコピーして、その後すぐにそのオブジェクトを破棄する」動作は、 「関数の戻り値オブジェクトをそのままその関数の呼び出し元で使用する」ことで効率的になる。 RVOとはこのような最適化を指す。

なお、このような最適化は、 C++17から規格化された。

SSO(Small String Optimization)

一般にstd::stringで文字列を保持する場合、newしたメモリが使用される。 64ビット環境であれば、newしたメモリのアドレスを保持する領域は8バイトになる。 std::stringで保持する文字列が終端の’\0’も含め8バイト以下である場合、 アドレスを保持する領域をその文字列の格納に使用すれば、newする必要がない(当然deleteも不要)。 こうすることで、短い文字列を保持するstd::stringオブジェクトは効率的に動作できる。

SOOとはこのような最適化を指す。

heap allocation elision

C++11までの仕様では、new式によるダイナミックメモリアロケーションはコードに書かれた通りに、 実行されなければならず、ひとまとめにしたり省略したりすることはできなかった。 つまり、ヒープ割り当てに対する最適化は認められなかった。 ダイナミックメモリアロケーションの最適化のため、この制限は緩和され、 new/deleteの呼び出しをまとめたり省略したりすることができるようになった。

    //  example/term_explanation/heap_allocation_elision_ut.cpp 4

    void lump()  // 実装によっては、ダイナミックメモリアロケーションをまとめらる場合がある
    {
        int* p1 = new int{1};
        int* p2 = new int{2};
        int* p3 = new int{3};

        // 何らかの処理

        delete p1;
        delete p2;
        delete p3;

        // 上記のメモリアロケーションは、実装によっては下記のように最適化される場合がある

        int* p = new int[3]{1, 2, 3};
        // 何らかの処理

        delete[] p;
    }

    int emit()  // ダイナミックメモリアロケーションの省略
    {
        int* p = new int{10};
        delete p;

        // 上記のメモリアロケーションは、下記の用にスタックの変数に置き換える最適化が許される

        int n = 10;

        return n;
    }

この最適化により、std::make_sharedのようにstd::shared_ptrの参照カウントを管理するメモリブロックと、 オブジェクトの実体を1つのヒープ領域に割り当てることができ、 ダイナミックメモリアロケーションが1回に抑えられるため、メモリアクセスが高速化される。

Most Vexing Parse

Most Vexing Parse(最も困惑させる構文解析)とは、C++の文法に関連する問題で、 Scott Meyersが彼の著書”Effective STL”の中でこの現象に名前をつけたことに由来する。

この問題はC++の文法が関数の宣言と変数の定義とを曖昧に扱うことによって生じる。 特にオブジェクトの初期化の文脈で発生し、意図に反して、その行は関数宣言になってしまう。

    //  example/term_explanation/most_vexing_parse_ut.cpp 6

    class Vexing {
    public:
        Vexing(int) {}
        Vexing() {}
    };

    //  example/term_explanation/most_vexing_parse_ut.cpp 21

    Vexing obj1();        // はローカルオブジェクトobj1の定義ではない
    Vexing obj2(Vexing);  // はローカルオブジェクトobj2の定義ではない
    Vexing(obj3);         // はローカルオブジェクトobj3の定義

    ASSERT_EQ("Vexing ()", Nstd::Type2Str<decltype(obj1)>());
    ASSERT_EQ("Vexing (Vexing)", Nstd::Type2Str<decltype(obj2)>());
    ASSERT_EQ("Vexing", Nstd::Type2Str<decltype(obj3)>());
    // 上記単体テストが示すように、
    //   * obj1はVexingを返す関数
    //   * obj2はVexingを引数に取りVexingを返す関数
    //   * obj3はVexing型のオブジェクト
    // となる。

初期化子リストコンストラクタの呼び出しでオブジェクトの初期化を行うことで、 このような問題を回避できる。

トライグラフ

トライグラフとは、2つの疑問符とその後に続く1文字によって表される、下記の文字列である。

    ??=  ??/  ??'  ??(  ??)  ??!  ??<  ??>  ??-

C++コンパイラ

本ドキュメントで使用するg++/clang++のバージョンは以下のとおりである。

g++

    g++ (Ubuntu 11.3.0-1ubuntu1~22.04) 11.3.0
    Copyright (C) 2021 Free Software Foundation, Inc.
    This is free software; see the source for copying conditions.  There is NO
    warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

clang++

    Ubuntu clang version 14.0.0-1ubuntu1
    Target: x86_64-pc-linux-gnu
    Thread model: posix
    InstalledDir: /usr/bin

ソフトウェア一般

ハンドル

CやC++の文脈でのハンドルとは、ポインタかリファレンスを指す。

フリースタンディング環境

フリースタンディング環境 とは、組み込みソフトウェアやOSのように、その実行にOSの補助を受けられないソフトウエアを指す。

サイクロマティック複雑度

サイクロマティック複雑度 とは関数の複雑さを表すメトリクスである。 このメトリクスの解釈は諸説あるものの、概ね以下のテーブルのようなものである。

サイクロマティック複雑度(CC) 複雑さの状態
CC <= 10 非常に良い構造
11 < CC < 30 やや複雑
31 < CC < 50 構造的なリスクあり
51 < CC テスト不可能、デグレードリスクが非常に高い

凝集度

凝集度 とはクラス設計の妥当性を表す尺度の一種であり、 「凝集度の欠如(LCOM)」というメトリクスで計測される。

    //  example/term_explanation/lack_of_cohesion_ut.cpp 7

    class ABC {
    public:
        explicit ABC(int32_t a, int32_t b, int32_t c) noexcept : a_{a}, b_{b}, c_{c} {}

        int32_t GetA() const noexcept { return a_; }
        int32_t GetB() const noexcept { return b_; }
        int32_t GetC() const noexcept { return c_; }
        void    SetA(int32_t a) noexcept { a_ = a; }
        void    SetB(int32_t b) noexcept { b_ = b; }
        void    SetC(int32_t c) noexcept { c_ = c; }

    private:
        int32_t a_;
        int32_t b_;
        int32_t c_;
    };

良く設計されたクラスは、下記のようにメンバが結合しあっているため凝集度が高い (ただし、「Immutable」の観点からは、QuadraticEquation::Set()がない方が良い)。 言い換えれば、凝集度を落とさずにクラスを分割することは難しい。 なお、上記のLCOM == 9なっているクラスを凝集性を高く、修正した例を以下に示す。

    //  example/term_explanation/lack_of_cohesion_ut.cpp 26

    class QuadraticEquation {  // 2次方程式
    public:
        explicit QuadraticEquation(int32_t a, int32_t b, int32_t c) noexcept : a_{a}, b_{b}, c_{c} {}

        void Set(int32_t a, int32_t b, int32_t c) noexcept
        {
            a_ = a;
            b_ = b;
            c_ = c;
        }

        int32_t Discriminant() const noexcept  // 判定式
        {
            return b_ * b_ - 4 * a_ * c_;
        }

        bool HasRealNumberSolution() const noexcept { return 0 <= Discriminant(); }

        std::pair<int32_t, int32_t> Solution() const;

    private:
        int32_t a_;
        int32_t b_;
        int32_t c_;
    };

    std::pair<int32_t, int32_t> QuadraticEquation::Solution() const
    {
        if (!HasRealNumberSolution()) {
            throw std::invalid_argument{"solution is an imaginary number"};
        }

        auto a0 = static_cast<int32_t>((-b_ - std::sqrt(Discriminant())) / 2);
        auto a1 = static_cast<int32_t>((-b_ + std::sqrt(Discriminant())) / 2);

        return {a0, a1};
    }

凝集度の欠如

凝集度の欠如(Lack of Cohesion in Methods/LCOM)とは、 クラス設計の妥当性を表す尺度の一種であり、0 ~ 1の値で表すメトリクスである。

LCOMの値が大きい(1か1に近い値)場合、「クラス内のメソッドが互いに関連性を持たず、 それぞれが独立した責務やデータに依存するため、クラス全体の統一性が欠けている」ことを表す。

クラスデザイン見直しの基準値としてLCOMを活用する場合、 LCOMの評価基準に具体的な推奨値を示す。

LCOMの評価基準

クラスデザイン良し悪しの基準値としてLCOMを活用する場合の推奨値を以下に示す。

凝集度の欠如(LCOM) クラスの状態
LCOM <= 0.4 理想的な状態
0.4 < LCOM < 0.6 要注意状態
0.6 <= LCOM 改善必須状態

Spurious Wakeup

Spurious Wakeupとは、 条件変数に対する通知待ちの状態であるスレッドが、その通知がされていないにもかかわらず、 起き上がってしまう現象のことを指す。

下記のようなstd::condition_variableの使用で起こり得る。

    //  example/term_explanation/spurious_wakeup_ut.cpp 8

    namespace {
    std::mutex              mutex;
    std::condition_variable cond_var;
    }  // namespace

    void notify_wrong()  // 通知を行うスレッドが呼び出す関数
    {
        auto lock = std::lock_guard{mutex};

        cond_var.notify_all();  // wait()で待ち状態のスレッドを起こす。
    }

    void wait_wrong()  // 通知待ちスレッドが呼び出す関数
    {
        auto lock = std::unique_lock{mutex};

        // notifyされるのを待つ。
        cond_var.wait(lock);  // notify_allされなくても起き上がってしまうことがある。

        // do something
    }

std::condition_variable::wait()の第2引数を下記のようにすることでこの現象を回避できる。

    //  example/term_explanation/spurious_wakeup_ut.cpp 34

    namespace {
    bool                    event_occured{false};
    std::mutex              mutex;
    std::condition_variable cond_var;
    }  // namespace

    void notify_right()  // 通知を行うスレッドが呼び出す関数
    {
        auto lock = std::lock_guard{mutex};

        event_occured = true;

        cond_var.notify_all();  // wait()で待ち状態のスレッドを起こす。
    }

    void wait_right()  // 通知待ちスレッドが呼び出す関数
    {
        auto lock = std::unique_lock{mutex};

        // notifyされるのを待つ。
        cond_var.wait(lock, []() noexcept { return event_occured; });  // Spurious Wakeup対策

        event_occured = false;

        // do something
    }

副作用

プログラミングにおいて、式の評価による作用には、 主たる作用とそれ以外の 副作用 (side effect)とがある。 式は、評価値を得ること(関数では「引数を受け取り値を返す」と表現する)が主たる作用とされ、 それ以外のコンピュータの論理的状態(ローカル環境以外の状態変数の値)を変化させる作用を副作用という。 副作用の例としては、グローバル変数や静的ローカル変数の変更、 ファイルの読み書き等のI/O実行、等がある。

is-a

「is-a」の関係は、オブジェクト指向プログラミング(OOP) においてクラス間の継承関係を説明する際に使われる概念である。 クラスDerivedとBaseが「is-a」の関係である場合、 DerivedがBaseの派生クラスであり、Baseの特性をDerivedが引き継いでいることを意味する。 C++でのOOPでは、DerivedはBaseのpublic継承として定義される。 通常DerivedやBaseは以下の条件を満たす必要がある。

「is-a」の関係とは「一種の~」と言い換えることができることが多い. ペンギンや九官鳥 は一種の鳥であるため、この関係を使用したコード例を次に示す。

    //  example/term_explanation/class_relation_ut.cpp 11

    class bird {
    public:
        //  事前条件: altitude  > 0 でなければならない
        //  事後条件: 呼び出しが成功した場合、is_flyingがtrueを返すことである
        virtual void fly(int altitude)
        {
            if (not(altitude > 0)) {  // 高度(altitude)は0より大きくなければ、飛べない
                throw std::invalid_argument{"altitude error"};
            }
            altitude_ = altitude;
        }

        bool is_flying() const noexcept
        {
            return altitude_ != 0;  // 高度が0でなければ、飛んでいると判断
        }

        virtual ~bird() = default;

    private:
        int altitude_ = 0;
    };

    class kyukancho : public bird {
    public:
        void speak()
        {
            // しゃべるため処理
        }

        // このクラスにget_nameを追加した理由はこの後を読めばわかる
        virtual std::string get_name() const  // その個体の名前を返す
        {
            return "no name";
        }
    };

bird::flyのオーバーライド関数(penguin::fly)について、リスコフの置換原則(LSP)に反した例を下記する。

    //  example/term_explanation/class_relation_ut.cpp 50

    class penguin : public bird {
    public:
        void fly(int altitude) override
        {
            if (altitude != 0) {
                throw std::invalid_argument{"altitude error"};
            }
        }
    };

    // 単体テストを行うためのラムダ
    auto let_it_fly = [](bird& b, int altitude) {
        try {
            b.fly(altitude);
        }
        catch (std::exception const&) {
            return 0;  // エクセプションが発生した
        }

        return b.is_flying() ? 2 : 1;  // is_flyingがfalseなら1を返す
    };

    bird    b;
    penguin p;
    ASSERT_EQ(let_it_fly(p, 0), 1);  // パスする
    // リスコフ置換原則が満たされていれば、派生クラス(penguin)
    // を基底クラス(bird)で置き換えても同じ結果になるはずだが、
    // 実際には逆に下記テストがパスしてしまう
    ASSERT_NE(let_it_fly(b, 0), 1);  // let_it_fly(b, 0) != 1 であることに注意
    // このことからpenguinへの派生はリスコフ置換の原則を満たさない

birdからpenguinへの派生がリスコフ置換の原則に反してしまった原因は以下のように考えることができる。

penguinとbirdの関係はis-aの関係ではあるが、 上記コードの問題によって不適切なis-aの関係と言わざるを得ない。

上記の例では鳥全般と鳥の種類のis-a関係をpublic継承を使用して表した(一部不適切であるもの)。 さらにis-aの誤った適用例を示す。 自身が飼っている九官鳥に”キューちゃん”と名付けることはよくあることである。 キューちゃんという名前の九官鳥は一種の九官鳥であることは間違いのないことであるが、 このis-aの関係を表すためにpublic継承を使用するのは、is-aの関係の誤用になることが多い。 実際のコード例を以下に示す。この場合、型とインスタンスの概念の混乱が原因だと思われる。

    //  example/term_explanation/class_relation_ut.cpp 91

    class q_chan : public kyukancho {
    public:
        std::string get_name() const override { return "キューちゃん"; }
    };

この誤用を改めた例を以下に示す。

    //  example/term_explanation/class_relation_ut.cpp 113

    class kyukancho {
    public:
        kyukancho(std::string name) : name_{std::move(name)} {}

        std::string const& get_name() const  // 名称をメンバ変数で保持するため、virtualである必要はない
        {
            return name_;
        }

        virtual ~kyukancho() = default;

    private:
        std::string const name_;  // 名称の保持
    };

    // ...

    kyukancho q{"キューちゃん"};

    ASSERT_EQ("キューちゃん", q.get_name());

修正されたKyukancho はstd::string インスタンスをメンバ変数として持ち、 kyukanchoとstd::stringの関係をhas-aの関係と呼ぶ。

has-a

「has-a」の関係は、 あるクラスのインスタンスが別のクラスのインスタンスを構成要素として含む関係を指す。 つまり、あるクラスのオブジェクトが別のクラスのオブジェクトを保持している関係である。

例えば、CarクラスとEngineクラスがあるとする。CarクラスはEngineクラスのインスタンスを含むので、 CarはEngineを「has-a」の関係にあると言える。 通常、has-aの関係はクラス内でメンバ変数またはメンバオブジェクトとして実装される。 Carクラスの例ではCarクラスにはEngine型のメンバ変数が存在する。

    //  example/term_explanation/class_relation_ut.cpp 144

    class Engine {
    public:
        void start() {}  // エンジンを始動するための処理
        void stop() {}   // エンジンを停止するための処理

    private:
        // ...
    };

    class Car {
    public:
        Car() : engine_{} {}
        void start() { engine_.start(); }
        void stop() { engine_.stop(); }

    private:
        Engine engine_;  // Car は Engine を持っている(has-a)
    };

is-implemented-in-terms-of

「is-implemented-in-terms-of」の関係は、 オブジェクト指向プログラミング(OOP)において、 あるクラスが別のクラスの機能を内部的に利用して実装されていることを示す概念である。 これは、あるクラスが他のクラスのインターフェースやメソッドを用いて、 自身の機能を提供する場合に使われる。 has-aの関係は、is-implemented-in-terms-of の関係の一種である。

is-implemented-in-terms-ofは下記の手段1-3に示した方法がある。

手段1. public継承によるis-implemented-in-terms-of
手段2. private継承によるis-implemented-in-terms-of
手段3. コンポジションによる(has-a)is-implemented-in-terms-of

手段1-3にはそれぞれ、長所、短所があるため、必要に応じて手段を選択する必要がある。 以下の議論を単純にするため、下記のようにクラスS、C、CCを定める。

コード量の観点から考えた場合、手段1が最も優れていることが多い。 依存関係の複雑さから考えた場合、CはSに強く依存する。 場合によっては、この依存はCCからSへの依存間にも影響をあたえる。 従って、手段3が依存関係を単純にしやすい。 手段1はis-aに見え、以下に示すような問題も考慮する必要があるため、 可読性、保守性を劣化させる可能性がある。

    //  example/term_explanation/class_relation_ut.cpp 260

    class MyString : public std::string {  // 手段1
    };

    // ...
    std::string* m_str = new MyString{"str"};

    // このようなpublic継承を行う場合、基底クラスのデストラクタは非virtualであるため、
    // 以下のコードではhmy_stringのデストラクタは呼び出されない。
    // この問題はリソースリークを発生させる場合がある。
    delete m_str;

以上述べたように問題の多い手段1であるが、実践的には有用なパターンであり、 CRTP(curiously recurring template pattern) の実現手段でもあるため、一概にコーディング規約などで排除することもできない。

public継承によるis-implemented-in-terms-of

public継承によるis-implemented-in-terms-ofの実装例を以下に示す。

    //  example/term_explanation/class_relation_ut.cpp 282

    class MyString : public std::string {};

    // ...
    MyString str{"str"};

    ASSERT_EQ(str[0], 's');
    ASSERT_STREQ(str.c_str(), "str");

    str.clear();
    ASSERT_EQ(str.size(), 0);

すでに述べたようにこの方法は、 private継承によるis-implemented-in-terms-ofや、 コンポジションによる(has-a)is-implemented-in-terms-of と比べコードがシンプルになる。

private継承によるis-implemented-in-terms-of

private継承によるis-implemented-in-terms-ofの実装例を以下に示す。

    //  example/term_explanation/class_relation_ut.cpp 179

    class MyString : std::string {
    public:
        using std::string::string;
        using std::string::operator[];
        using std::string::c_str;
        using std::string::clear;
        using std::string::size;
    };

    // ...
    MyString str{"str"};

    ASSERT_EQ(str[0], 's');
    ASSERT_STREQ(str.c_str(), "str");

    str.clear();
    ASSERT_EQ(str.size(), 0);

この方法は、public継承によるis-implemented-in-terms-ofが持つデストラクタ問題は発生せす、 is-aと誤解してしまう問題も発生しない。

コンポジションによる(has-a)is-implemented-in-terms-of

コンポジションによる(has-a)is-implemented-in-terms-ofの実装例を示す。

    //  example/term_explanation/class_relation_ut.cpp 207

    namespace is_implemented_in_terms_of_1 {
    class MyString {
    public:
        // コンストラクタ
        MyString() = default;
        MyString(const std::string& str) : str_(str) {}
        MyString(const char* cstr) : str_(cstr) {}

        // 文字列へのアクセス
        const char* c_str() const { return str_.c_str(); }

        using reference = std::string::reference;
        using size_type = std::string::size_type;

        reference operator[](size_type pos) { return str_[pos]; }

        // その他のメソッドも必要に応じて追加する
        // 以下は例
        std::size_t size() const { return str_.size(); }

        void clear() { str_.clear(); }

        MyString& operator+=(const MyString& rhs)
        {
            str_ += rhs.str_;
            return *this;
        }

    private:
        std::string str_;
    };

    // ...
    MyString str{"str"};

    ASSERT_EQ(str[0], 's');
    ASSERT_STREQ(str.c_str(), "str");

    str.clear();
    ASSERT_EQ(str.size(), 0);

この方は実装を利用するクラストの依存関係を他の2つに比べるとシンプルにできるが、 逆に実装例から昭なとおり、コード量が増えてしまう。

非ソフトウェア用語

割れ窓理論

割れ窓理論とは、 軽微な犯罪も徹底的に取り締まることで、凶悪犯罪を含めた犯罪を抑止できるとする環境犯罪学上の理論。 アメリカの犯罪学者ジョージ・ケリングが考案した。 「建物の窓が壊れているのを放置すると、誰も注意を払っていないという象徴になり、 やがて他の窓もまもなく全て壊される」との考え方からこの名がある。

ソフトウェア開発での割れ窓とは、「朝会に数分遅刻する」、「プログラミング規約を守らない」 等の軽微なルール違反を指し、この理論の実践には、このような問題を放置しないことによって、

等の重要な狙いがある。

車輪の再発明

車輪の再発明 とは、広く受け入れられ確立されている技術や解決法を(知らずに、または意図的に無視して) 再び一から作ること」を指すための慣用句である。 ソフトウェア開発では、STLのような優れたライブラリを使わずに、 それと同様なライブラリを自分たちで実装するような非効率な様を指すことが多い。

Sample Code

C++

example/dynamic_memory_allocation/malloc_ut.cpp

          1 #include <sys/unistd.h>
          2 
          3 #include <cassert>
          4 #include <cstdint>
          5 #include <mutex>
          6 
          7 #include "gtest_wrapper.h"
          8 
          9 #include "dynamic_memory_allocation_ut.h"
         10 #include "spin_lock.h"
         11 #include "utils.h"
         12 
         13 // @@@ sample begin 0:0
         14 
         15 extern "C" void* sbrk(ptrdiff_t __incr);
         16 // @@@ sample end
         17 
         18 namespace MallocFree {
         19 // @@@ sample begin 1:0
         20 
         21 namespace {
         22 
         23 struct header_t {
         24     header_t* next;
         25     size_t    n_nuits;  // header_tが何個あるか
         26 };
         27 
         28 header_t*        header{nullptr};
         29 SpinLock         spin_lock{};
         30 constexpr size_t unit_size{sizeof(header_t)};
         31 
         32 inline bool sprit(header_t* header, size_t n_nuits, header_t*& next) noexcept
         33 {
         34     // @@@ ignore begin
         35     assert(n_nuits > 1);  // ヘッダとバッファなので最低でも2
         36 
         37     next = nullptr;
         38 
         39     if (header->n_nuits == n_nuits || header->n_nuits == n_nuits + 1) {
         40         next = header->next;
         41         return true;
         42     }
         43     else if (header->n_nuits > n_nuits) {
         44         next            = header + n_nuits;
         45         next->n_nuits   = header->n_nuits - n_nuits;
         46         next->next      = header->next;
         47         header->n_nuits = n_nuits;
         48         return true;
         49     }
         50 
         51     return false;
         52     // @@@ ignore end
         53 }
         54 
         55 inline void concat(header_t* front, header_t* rear) noexcept
         56 {
         57     // @@@ ignore begin
         58     if (front + front->n_nuits == rear) {  // 1枚のメモリになる
         59         front->n_nuits += rear->n_nuits;
         60         front->next = rear->next;
         61     }
         62     else {
         63         front->next = rear;
         64     }
         65     // @@@ ignore end
         66 }
         67 
         68 header_t* set_back(void* mem) noexcept { return static_cast<header_t*>(mem) - 1; }
         69 
         70 static_assert(sizeof(header_t) == alignof(std::max_align_t));
         71 
         72 void* malloc_inner(size_t size) noexcept
         73 {
         74     // @@@ ignore begin
         75     // size分のメモリとヘッダ
         76     auto n_nuits = (Roundup(unit_size, size) / unit_size) + 1;
         77     auto lock    = std::lock_guard{spin_lock};
         78 
         79     auto curr = header;
         80     for (header_t* prev = nullptr; curr != nullptr; prev = curr, curr = curr->next) {
         81         header_t* next;
         82 
         83         if (!sprit(curr, n_nuits, next)) {
         84             continue;
         85         }
         86 
         87         if (prev == nullptr) {
         88             header = next;
         89         }
         90         else {
         91             prev->next = next;
         92         }
         93         break;
         94     }
         95 
         96     if (curr != nullptr) {
         97         ++curr;
         98     }
         99 
        100     return curr;
        101     // @@@ ignore end
        102 }
        103 }  // namespace
        104 // @@@ sample end
        105 // @@@ sample begin 2:0
        106 
        107 void free(void* mem) noexcept
        108 {
        109     header_t* mem_to_free = set_back(mem);
        110 
        111     mem_to_free->next = nullptr;
        112 
        113     auto lock = std::lock_guard{spin_lock};
        114 
        115     if (header == nullptr) {
        116         header = mem_to_free;
        117         return;
        118     }
        119     // @@@ sample end
        120     // @@@ sample begin 2:1
        121 
        122     if (mem_to_free < header) {
        123         concat(mem_to_free, header);
        124         header = mem_to_free;
        125         return;
        126     }
        127 
        128     auto curr = header;
        129     for (; curr->next != nullptr; curr = curr->next) {
        130         if (mem_to_free < curr->next) {  // 常に curr < mem_to_free
        131             concat(mem_to_free, curr->next);
        132             concat(curr, mem_to_free);
        133             return;
        134         }
        135     }
        136 
        137     concat(curr, mem_to_free);
        138     // @@@ sample end
        139     // @@@ sample begin 2:2
        140 }
        141 // @@@ sample end
        142 // @@@ sample begin 3:0
        143 
        144 void* malloc(size_t size) noexcept
        145 {
        146     void* mem = malloc_inner(size);
        147     // @@@ sample end
        148     // @@@ sample begin 3:1
        149 
        150     if (mem == nullptr) {
        151         auto const add_size = Roundup(unit_size, 1024 * 1024 + size);  // 1MB追加
        152 
        153         header_t* add = static_cast<header_t*>(sbrk(add_size));
        154         add->n_nuits  = add_size / unit_size;
        155         free(++add);
        156         mem = malloc_inner(size);
        157     }
        158     // @@@ sample end
        159     // @@@ sample begin 3:2
        160 
        161     return mem;
        162 }
        163 // @@@ sample end
        164 
        165 namespace {
        166 TEST(NewDelete_Opt, malloc)
        167 {
        168     {
        169         void* mem = malloc(1024);
        170 
        171         ASSERT_NE(nullptr, mem);
        172         free(mem);
        173 
        174         void* ints[8]{};
        175 
        176         constexpr auto n_nuits = Roundup(unit_size, unit_size + sizeof(int)) / unit_size;
        177 
        178         for (auto& i : ints) {
        179             i = malloc(sizeof(int));
        180 
        181             header_t* h = set_back(i);
        182             ASSERT_EQ(h->n_nuits, n_nuits);
        183         }
        184 
        185         for (auto& i : ints) {
        186             free(i);
        187         }
        188     }
        189 
        190     // @@@ sample begin 4:0
        191 
        192     void* mem[1024];
        193 
        194     for (auto& m : mem) {  // 32バイト x 1024個のメモリ確保
        195         m = malloc(32);
        196     }
        197 
        198     // memを使用した何らかの処理
        199     // @@@ ignore begin
        200     // @@@ ignore end
        201 
        202     for (auto i = 0U; i < ArrayLength(mem); i += 2) {  // 512個のメモリを解放
        203         free(mem[i]);
        204     }
        205     // @@@ sample end
        206 
        207     for (auto i = 1U; i < ArrayLength(mem); i += 2) {
        208         free(mem[i]);
        209     }
        210 }
        211 }  // namespace
        212 }  // namespace MallocFree

example/dynamic_memory_allocation/mpool_variable.h

          1 #pragma once
          2 #include <cassert>
          3 #include <cstdint>
          4 #include <mutex>
          5 #include <optional>
          6 
          7 #include "mpool.h"
          8 #include "spin_lock.h"
          9 #include "utils.h"
         10 
         11 namespace Inner_ {
         12 
         13 struct header_t {
         14     header_t* next;
         15     size_t    n_nuits;  // header_tが何個あるか
         16 };
         17 
         18 constexpr auto unit_size = sizeof(header_t);
         19 
         20 inline std::optional<header_t*> sprit(header_t* header, size_t n_nuits) noexcept
         21 {
         22     assert(n_nuits > 1);  // ヘッダとバッファなので最低でも2
         23 
         24     if (header->n_nuits == n_nuits || header->n_nuits == n_nuits + 1) {
         25         return header->next;
         26     }
         27     else if (header->n_nuits > n_nuits) {
         28         auto next       = header + n_nuits;
         29         next->n_nuits   = header->n_nuits - n_nuits;
         30         next->next      = header->next;
         31         header->n_nuits = n_nuits;
         32         return next;
         33     }
         34 
         35     return std::nullopt;
         36 }
         37 
         38 inline void concat(header_t* front, header_t* rear) noexcept
         39 {
         40     if (front + front->n_nuits == rear) {  // 1枚のメモリになる
         41         front->n_nuits += rear->n_nuits;
         42         front->next = rear->next;
         43     }
         44     else {
         45         front->next = rear;
         46     }
         47 }
         48 
         49 inline header_t* set_back(void* mem) noexcept { return static_cast<header_t*>(mem) - 1; }
         50 
         51 static_assert(sizeof(header_t) == alignof(std::max_align_t));
         52 
         53 template <uint32_t MEM_SIZE>
         54 struct buffer_t {
         55     alignas(alignof(std::max_align_t)) uint8_t buffer[Roundup(sizeof(header_t), MEM_SIZE)];
         56 };
         57 }  // namespace Inner_
         58 
         59 // @@@ sample begin 0:0
         60 
         61 template <uint32_t MEM_SIZE>
         62 class MPoolVariable final : public MPool {
         63 public:
         64     // @@@ sample end
         65     // @@@ sample begin 0:1
         66     MPoolVariable() noexcept : MPool{MEM_SIZE}
         67     {
         68         header_->next    = nullptr;
         69         header_->n_nuits = sizeof(buff_) / Inner_::unit_size;
         70     }
         71     // @@@ sample end
         72     // @@@ sample begin 0:2
         73 
         74     class const_iterator {
         75     public:
         76         explicit const_iterator(Inner_::header_t const* header) noexcept : header_{header} {}
         77         const_iterator(const_iterator const&) = default;
         78         const_iterator(const_iterator&&)      = default;
         79 
         80         const_iterator& operator++() noexcept  // 前置++のみ実装
         81         {
         82             assert(header_ != nullptr);
         83             header_ = header_->next;
         84 
         85             return *this;
         86         }
         87 
         88         Inner_::header_t const* operator*() noexcept { return header_; }
         89 
         90         // clang-format off
         91 
         92     #if __cplusplus <= 201703L  // c++17
         93         bool operator==(const_iterator const& rhs) noexcept { return header_ == rhs.header_; }
         94         bool operator!=(const_iterator const& rhs) noexcept { return !(*this == rhs); }
         95     #else  // c++20
         96 
         97         auto operator<=>(const const_iterator&) const = default;
         98     #endif
         99         // clang-format on
        100 
        101     private:
        102         Inner_::header_t const* header_;
        103     };
        104 
        105     const_iterator begin() const noexcept { return const_iterator{header_}; }
        106     const_iterator end() const noexcept { return const_iterator{nullptr}; }
        107     const_iterator cbegin() const noexcept { return const_iterator{header_}; }
        108     const_iterator cend() const noexcept { return const_iterator{nullptr}; }
        109     // @@@ sample end
        110     // @@@ sample begin 0:3
        111 
        112 private:
        113     using header_t = Inner_::header_t;
        114 
        115     Inner_::buffer_t<MEM_SIZE> buff_{};
        116     header_t*                  header_{reinterpret_cast<header_t*>(buff_.buffer)};
        117     mutable SpinLock           spin_lock_{};
        118     size_t                     unit_count_{sizeof(buff_) / Inner_::unit_size};
        119     size_t                     unit_count_min_{sizeof(buff_) / Inner_::unit_size};
        120 
        121     virtual void* alloc(size_t size) noexcept override
        122     {
        123         // @@@ ignore begin
        124         // size分のメモリとヘッダ
        125         auto n_nuits = (Roundup(Inner_::unit_size, size) / Inner_::unit_size) + 1;
        126 
        127         auto lock = std::lock_guard{spin_lock_};
        128 
        129         auto curr = header_;
        130 
        131         for (header_t* prev{nullptr}; curr != nullptr; prev = curr, curr = curr->next) {
        132             auto opt_next = std::optional<header_t*>{sprit(curr, n_nuits)};
        133 
        134             if (!opt_next) {
        135                 continue;
        136             }
        137 
        138             auto next = *opt_next;
        139             if (prev == nullptr) {
        140                 header_ = next;
        141             }
        142             else {
        143                 prev->next = next;
        144             }
        145             break;
        146         }
        147 
        148         if (curr != nullptr) {
        149             unit_count_ -= curr->n_nuits;
        150             unit_count_min_ = std::min(unit_count_, unit_count_min_);
        151             ++curr;
        152         }
        153 
        154         return curr;
        155         // @@@ ignore end
        156     }
        157 
        158     virtual void free(void* mem) noexcept override
        159     {
        160         // @@@ ignore begin
        161         header_t* to_free = Inner_::set_back(mem);
        162 
        163         to_free->next = nullptr;
        164 
        165         auto lock = std::lock_guard{spin_lock_};
        166 
        167         unit_count_ += to_free->n_nuits;
        168         unit_count_min_ = std::min(unit_count_, unit_count_min_);
        169 
        170         if (header_ == nullptr) {
        171             header_ = to_free;
        172             return;
        173         }
        174 
        175         if (to_free < header_) {
        176             concat(to_free, header_);
        177             header_ = to_free;
        178             return;
        179         }
        180 
        181         header_t* curr = header_;
        182 
        183         for (; curr->next != nullptr; curr = curr->next) {
        184             if (to_free < curr->next) {  // 常に curr < to_free
        185                 concat(to_free, curr->next);
        186                 concat(curr, to_free);
        187                 return;
        188             }
        189         }
        190 
        191         concat(curr, to_free);
        192         // @@@ ignore end
        193     }
        194 
        195     virtual size_t get_size() const noexcept override { return 1; }
        196     virtual size_t get_count() const noexcept override { return unit_count_ * Inner_::unit_size; }
        197     virtual size_t get_count_min() const noexcept override { return unit_count_min_ * Inner_::unit_size; }
        198 
        199     virtual bool is_valid(void const* mem) const noexcept override
        200     {
        201         return (&buff_ < mem) && (mem < &buff_.buffer[ArrayLength(buff_.buffer)]);
        202     }
        203     // @@@ sample end
        204     // @@@ sample begin 0:4
        205 };
        206 // @@@ sample end